aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index ca640a3..a3eb51f 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,16 @@ object once its upload has completed. If you run
twice, the second invocation will skip uploading altogether and only run the
integrity-checking code.
+## Building
+
+`gsrsup` builds using a handwritten [Ninja](https://ninja-build.org/) file.
+Simply run `ninja` to create a development build. You can also run Ninja with a
+custom build file to request a different profile:
+
+ - `ninja -f buildconf/asan.ninja`: Build with AddressSanitizer.
+ - `ninja -f buildconf/dbg.ninja`: Build for debugging.
+ - `ninja -f buildconf/release.ninja`: Build with optimizations.
+
---
This is not an official Google product.