From 9929a5c154cc529ab016704a40ade2bb1d526b29 Mon Sep 17 00:00:00 2001 From: q66 Date: Sun, 30 Aug 2015 00:23:02 -0700 Subject: [PATCH] readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 072d882..42c90e2 100644 --- a/README.md +++ b/README.md @@ -24,4 +24,16 @@ Upcoming features: * Automatic dependency tracking * Shell independence * Proper argument handling - * Platform related utilities \ No newline at end of file + * Platform related utilities + +## Usage + +Use the provided script to build OctaBuild itself. You will need libcubescript +and octastd in the right paths (you can adjust these paths within `compile.sh`) +in order to compile it. There is a provided example build script in `example`. + +The octabuild binary supports the `-h` option to display help. + +## License + +See `COPYING.md`. \ No newline at end of file