From 3225d8ebf6cff3136f76abe5612d8f66acfad8b2 Mon Sep 17 00:00:00 2001 From: q66 Date: Sun, 13 Sep 2015 23:25:07 +0100 Subject: [PATCH] readme --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 42c90e2..142be92 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # octabuild -OctaBuild is a simple build system inspired by Make, but using the Cubescript -language to write build definitions and not depending on a shell to function. -It'll also feature things such as automatic dependency tracking and a large -utility library abstracting away platform differences. +OctaBuild is a simple build system inspired by Make, but using the +Cubescript language to write build definitions and not depending on a +shell to function. It'll also feature things such as automatic dependency +tracking and a large utility library abstracting away platform differences. -It can be used standalone at this point. Once everything is more done, a library -form will be introduced. +It can be used standalone at this point. Once everything is more done, a +library form will be introduced. It needs libcubescript to function, which you can fetch at https://git.octaforge.org/tools/libcubescript.git/ or at @@ -28,9 +28,12 @@ Upcoming features: ## 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`. +Use the provided script to build OctaBuild itself. You will need +libcubescript and octastd in the right paths. + +Use the provided Makefile to build - adjust the paths to OctaSTD and +libcubescript if necessary. There is a provided example build script +in `example`. The octabuild binary supports the `-h` option to display help.