aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThomas Voss <mail@thomasvoss.com> 2024-01-23 15:45:19 +0100
committerThomas Voss <mail@thomasvoss.com> 2024-01-23 15:45:19 +0100
commitaf4345918d6e848bcc2eeb6957bbc8405219e18b (patch)
tree134d2424f60682d7be60de7d282d643ed6979df9 /README.md
parent5313b36432f6821059e6ebf9df0c9a74bd6c8e15 (diff)
Add note to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 03297c2..94c899f 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,22 @@ All functions and macros are documented in cbs.h.
CBS is very much inspired by Tsoding’s ‘Nob’.
+## Important
+
+This library works with the assumption that your compiled build script
+*and* your build script source code are located in the **same
+directory**. The general project structure of your project is intended
+to look like so:
+
+```
+.
+├── cbs.h # This library
+├── make # The compiled build script
+├── make.c # The build script source
+└── … # Your own files
+```
+
+
## Example
Assuming you have a source file `my-file.c` — you can compile this build