aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Moon Flower <moon@coffin.ir> 2025-03-11 22:55:14 +0330
committerGravatar Moon Flower <moon@coffin.ir> 2025-03-11 22:55:14 +0330
commit78041817542a06e817281d6614fc67be7c6196a5 (patch)
treec9a660c837264e84e94fb08017d1fb8bfadf8a6a /README.md
parentImprove allocation fallback (diff)
Converted the build system to C! + Slight improvements
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
index c776252..2df30b8 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,32 @@ This library relies upon nothing but the C language itself, not even the standar
Support for more operating systems and architectures is not part of the goals of this project, but it is a consideration to be kept in mind.
That said, any contribution to expand support to other configurations are absolutely welcome.
+## Usage guide
+First, build the builder (yes, the build system and macro generator are written in no-libc C as well):
+```sh
+$ clang build.c -nostdlib -o builder
+```
+Run it for a guide:
+```sh
+$ ./builder
+```
+Build the macros:
+```sh
+$ ./builder macro
+```
+Verify the test cases:
+```sh
+$ ./builder run
+```
+Install moonshine:
+```sh
+$ ./builder install
+```
+All-in-one quick install:
+```sh
+$ ./builder all
+```
+
## Current features
- Mark & Sweep garbage collector for responsible memory management (must be manually called, for now)
- Easy array creation: `new(int)`, `new(char, 4)`, `fill(int, 2, 4, 5)`, `fill(string, "hello", "world")`, `single("string")`, `single(22.4)`