hacking notes

1 files changed, 10 insertions, 0 deletions

diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..6707c7b
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,10 @@
+Generating the docs:
+  sudo apt-get install asciidoc --no-install-recommends
+  ./ninja doc
+
+Test-driven development:
+  Set your build command to
+    ./ninja ninja_test && ./ninja_test --gtest_filter=MyTest.Name
+  now you can repeatedly run that while developing until the tests pass.
+  Remember to build "all" before committing to verify the other source
+  still works!