From af4345918d6e848bcc2eeb6957bbc8405219e18b Mon Sep 17 00:00:00 2001 From: Thomas Voss Date: Tue, 23 Jan 2024 15:45:19 +0100 Subject: Add note to README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) 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 -- cgit v1.2.3