aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2018-09-23 12:31:44 +0200
committerdec05eba <dec05eba@protonmail.com>2020-07-06 07:39:33 +0200
commit8d7bf2c29dea885b1f7d51e1f67ba6430a5890b0 (patch)
treecd7e7200b5ca9889176387ed18f18fd4ec7e4e8e /README.md
parent5006226e945fc645e6d9b21252c9eee53cc191cc (diff)
Update readme with info about zig header files
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/README.md b/README.md
index 7cc8ae8..41b71f6 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,9 @@ Sibs is still in very early testing phase, should only be used if you want to to
Sibs is inspired by [Cargo](https://github.com/rust-lang/cargo/), you can think of it like a C/C++/Zig version of Cargo.
Zig support has not been tested properly yet and currently always links to c library and requires a C/C++ compiler to build (for linking).
You can run zig tests with `sibs test --file filepath` or `sibs test --all-files`.
-Currently zig tests are cached because ninja build system is used, which means if source files do not change between runs,
-then tests wont run. This should be fixed later...
+Currently zig tests are cached because ninja build system is used, which means if source files do not change between runs.
+Currently zig files generate header files and include exported functions into sibs-build/generated-headers/zig and the generated headers
+are usable from c/c++ by using including: `#include <zig/INSERT_ZIG_HEADER_FILE_NAME_HERE>`
The CMakeLists.txt is only for development purpose and only compiles on linux.