aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2018-09-29 13:41:50 +0200
committerdec05eba <dec05eba@protonmail.com>2020-07-06 07:39:33 +0200
commitba960a24615b39a4e145b7286afe0f1b5047020a (patch)
tree32a1c9701bf766527553ef99349225f85b111d58 /README.md
parent527179c68597b907dbd6bdc6489181306e9e19ec (diff)
Update README with supported platforms
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7bc8d2f..beb2260 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,15 @@ The CMakeLists.txt should only be used during development or when installing sib
To compile under windows you can use vcpkg to install dependencies and then generate visual studio project using cmake.
List of packages can be found at https://gitlab.com/DEC05EBA/sibs_packages/raw/master/packages.json
+
+### Supported platforms
+|Linux|Windows|MacOS |... |
+|-----|-------|-----------|-----------|
+|✓ |✓ |In progress|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.
+
+Linux is the primary platform, the platform which master branch is guaranteed to compile on.
+
# Installation
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 Linux you need to build from source by running install.sh under cmake directory.