From bbf7028e9d4f0667000210ce179998880e3ade09 Mon Sep 17 00:00:00 2001
From: Jesse Millwood <dev@millwood.earth>
Date: Tue, 29 Oct 2024 16:01:30 -0400
Subject: [PATCH] Initial commit of readme

---
 Readme.org | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 Readme.org

diff --git a/Readme.org b/Readme.org
new file mode 100644
index 0000000..b296da7
--- /dev/null
+++ b/Readme.org
@@ -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