aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index b80260b..35677d4 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ Sibs is inspired by [Cargo](https://github.com/rust-lang/cargo/), you can think
Zig support has not been tested properly yet and currently always links to c library.
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.
-Currently zig files generate header files and include exported functions into sibs-build/generated-headers/zig and the generated headers
+Currently zig files generate header files and include exported functions into `sibs-build/<platform>/generated-headers/zig` and the generated headers
are usable from c/c++ by using including: `#include <zig/INSERT_ZIG_HEADER_FILE_NAME_HERE>`.
If your project contains zig files then it will currently only run on Linux, Windows and MacOS as zig doesn't support more platforms at the moment.
@@ -28,7 +28,7 @@ Linux is the primary platform, the platform which master branch is guaranteed to
Newest version of sibs builds itself. If you don't already have sibs installed and you are using Windows then you can find prebuilt binary under msvc folder.
On MacOS, OpenBSD and Haiku you need to install from source by running install.sh under cmake directory.
On Linux you can install from source by running install.sh under cmake directory or if you are using Arch Linux you can use the PKGBUILD under distribute/arch_linux. You can also use prebuild package under distribute/linux_x86_64 if you are running on x86_64 machine.
-After you've installed sibs once, you can install new versions by running install.sh (or use `sibs.exe build --release` if you are on windows, and sibs binary will be located under sibs-build/release/sibs.exe).
+After you've installed sibs once, you can install new versions by running install.sh (or use `sibs.exe build --release` if you are on windows, and sibs binary will be located under `sibs-build/<platform>/release/sibs.exe`).
For easiest usage of sibs under windows, add msvc subdirectory to PATH environment variable. msvc subdirectory also contains additional libraries and software that is needed for sibs to run
with the only missing software being cmake.