aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCharlie Root <root@dec05eba.my.domain>2018-09-30 23:44:13 +0200
committerdec05eba <dec05eba@protonmail.com>2020-07-06 07:39:33 +0200
commit0b09e97d0d6163b5a898f5642505ee12dd5ef30e (patch)
tree6464ce5279090cf99aa957aaca1faf68c50db095 /README.md
parent147188af8356d21fb9720308ef4912e1f3a22a15 (diff)
Add OpenBSD support
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index ca29499..79cdc9a 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,8 @@ Zig support has not been tested properly yet and currently always links to c lib
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
-are usable from c/c++ by using including: `#include <zig/INSERT_ZIG_HEADER_FILE_NAME_HERE>`
+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.
The CMakeLists.txt should only be used during development or when installing sibs for the first time.
To compile under windows you can use vcpkg to install dependencies and then generate visual studio project using cmake.
@@ -14,9 +15,9 @@ To compile under windows you can use vcpkg to install dependencies and then gene
List of packages can be found at https://gitlab.com/DEC05EBA/sibs_packages/raw/master/packages.json
### Supported platforms
-|Linux|Windows|MacOS |... |
-|-----|-------|-----------|-----------|
-|✓ |✓ |✓ |TBD* |
+|Linux|Windows|MacOS |OpenBSD|... |
+|-----|-------|-----------|-----------|---|
+|✓ |✓ |✓ |✓|TBD* |
\* Sibs is intended to work on as many platforms as possible, you can help by porting sibs to another platform. Should only be minor changes if the platform is unix-like.
@@ -45,7 +46,7 @@ If your project contains a sub directory called "tests" then that directory will
name = "packageName"
type = "library"
version = "0.1.0"
-platforms = ["linux32", "linux64", "win32", "win64", "macos32", "macos64"]
+platforms = ["linux32", "linux64", "win32", "win64", "macos32", "macos64", "openbsd32", "openbsd64"]
authors = ["DEC05EBA <0xdec05eba@gmail.com>"]
[dependencies]
@@ -100,7 +101,7 @@ Required. Should be one of: "executable", "static", "dynamic", "library"
### version
Required. Version string has to be in the format of "xxx.yyy.zzz" where xxx is major, yyy is minor and zzz is patch
### platforms
-Required. A list of platforms the package supports. Can contain the following values: "any", "linux32", "linux64", "win32", "win64", "macos32", "macos64".
+Required. A list of platforms the package supports. Can contain the following values: "any", "linux32", "linux64", "win32", "win64", "macos32", "macos64", "openbsd32", "openbsd64".
If platforms contains "any", then other there is no need to specify other platforms
### authors
Optional. A list of authors