Initial commit of readme

This commit is contained in:
Jesse Millwood 2024-10-29 16:01:30 -04:00
commit bbf7028e9d

32
Readme.org Normal file
View File

@ -0,0 +1,32 @@
#+title: Data Structures And Algorithms Studying in C++
#+author: Jesse Millwood
#+email: jesse@millwood.earth
#+startup: showall indent
#+options: toc:nil
* Overview
This is just studying for coding interviews. It loosely follows "Cracking the
Coding Interview" by Gayle Laakmann McDowell. The code is structured by keeping
the implementations in the =lib= directory and the study questions in the =tests=
directory. The build system, =meson=, supports pulling down other projects and integrating them. CPPUTEST is pulled down with a wrap file.
* Initialization
** Toolchain
I use [[https://www.jetify.com/docs/devbox][=devbox=]] to handle the toolchain dependencies. If you have not installed
it, it is pretty easy at [[https://jetify.com/docs/installing_devbox][Installing Devbox]]. After that just run the following in
a shell from this directory:
#+begin_src sh
devbox shell
#+end_src
** The Build System (Meson)
Initialize build directory and pull down the sub projects via the meson "wrap"
feature:
#+begin_src sh
meson setup build
#+end_src
* Testing
To run the tests:
#+begin_src sh
meson test -C build
#+end_src