0x221E/ibuild
1
1
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases Wiki Activity

Readme: Modify README.md to fit current version

Browse Source
This commit is contained in:
0x221E
2026-01-18 11:18:27 +01:00
parent fbb1868d82
commit 5fd1f72624
1 changed files with 9 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -1,5 +1,5 @@
# ibuild # 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 ## 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). 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. Then run `ibuild`, and it should build the binary.
## Configuration File ## Configuration File
Below is a sample configuration file; Below is a sample (future) syntax;
```` ````
COMPILER_PATH = "/usr/bin/gcc" KEY = "VALUE";
SRC_DIR = "src" # Recursively discovers files here KEY = ["VALUE1", "VALUE2"];
SRC_FILES = ["src/main.c"] # Manual file specification is optional ````
TARGET_EXEC = "ibuild" # executable name ### All Key-Values
DEP_SEARCHER = "/usr/bin/gcc" # Default, no need to specify explicitly | Key | Value |
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. | CC_COMPILER_PATH | `e.g. /usr/bin/gcc`|
````