From 5fd1f72624c0d2c1daa5b6edb2c26b160c2b049f Mon Sep 17 00:00:00 2001 From: 0x221E Date: Sun, 18 Jan 2026 11:18:27 +0100 Subject: [PATCH] Readme: Modify README.md to fit current version --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a6ebf86..de5d4f8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # ibuild -A simple build system written in C. The project is incomplete and is not meant to be used by anyone. It is designed to work out-of-the-box on C/C++ projects. However, it has a Recursive Descent Parser and supports a very small DSL. The DSL is in the format of a very basic configuration file. As of now, there is no complex configuration support as well as cross-platform compatibility features, as this is only available in linux. +A simple build system written in C. The project is incomplete and is not meant to be used by anyone. It is designed to work out-of-the-box on C/C++ projects. ## Security Disclaimer The project has not been battle-tested yet. I am not using as a daily driver yet, and when I do, I will conduct thorough testing by fuzzing the application continously for a period of time (likely a week). @@ -12,13 +12,12 @@ You either place the executable to your /usr/local/bin, or place it into your pr Then run `ibuild`, and it should build the binary. ## Configuration File -Below is a sample configuration file; +Below is a sample (future) syntax; ```` -COMPILER_PATH = "/usr/bin/gcc" -SRC_DIR = "src" # Recursively discovers files here -SRC_FILES = ["src/main.c"] # Manual file specification is optional -TARGET_EXEC = "ibuild" # executable name -DEP_SEARCHER = "/usr/bin/gcc" # Default, no need to specify explicitly -DEP_SEARCHER_FLAGS = "-MM" # Default, no need to specify explicitly -VERSION = "0.0.1" # Can specify version here, which would be passed as a macro. -```` \ No newline at end of file +KEY = "VALUE"; +KEY = ["VALUE1", "VALUE2"]; +```` +### All Key-Values +| Key | Value | +| --- | --- | +| CC_COMPILER_PATH | `e.g. /usr/bin/gcc`| \ No newline at end of file