initial commit

Signed-off-by: Chloe M <chloe@faracom.org>

1 files changed, 20 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d9be184
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Bop is a quick and minimal build utility to serve as an alternative to MAKE
+
+## Hooks
+
+# Hooks may be placed in the target build directory as such:
+
+```
+$TARGET/.bop/posthook.sh    - Runs after the build
+$TARGET/.bop/prehook.sh     - Runs before the build
+```
+
+To build a directory with CFILES, run:
+
+```
+user@host~$ : BOP_BUILD=$TARGET bop build
+```
+
+## Screenshot and example
+
+![bop](https://git.faracom.org/chloe/bop/raw/branch/main/.assets/bop.png)