From 15e05a321c6c0f92a6cf5b01704b80ac15022f60 Mon Sep 17 00:00:00 2001 From: dec05eba Date: Thu, 22 Aug 2019 20:12:31 +0200 Subject: Update readme --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 7e964fb..00ae762 100644 --- a/README.md +++ b/README.md @@ -27,19 +27,17 @@ List of packages can be found at https://gitlab.com/DEC05EBA/sibs_packages/raw/m Linux is the primary platform, the platform which master branch is guaranteed to compile on. +# Dependencies +`libcurl, libarchive, libgit2, curl, ninja, cmake` + # 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 (OUTDATED, build from source). -On Linux, MacOS, OpenBSD and Haiku you need to install from source by running install.sh under cmake directory. -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`). -For easiest usage of sibs under windows. - -Dependencies that are required to build sibs from source are: -`libcurl, libarchive, libgit2, curl` - -`Ninja (build system)` needs to be installed on the system to be able to build projects. CMake can be required for some projects that uses cmake files to build project instead of sibs. -Ccache is currently required on non-windows platforms but it will later be removed and replaced with sibs own caching system. Ninja will also be removed as backend build system. +## Posix (Linux, MacOS, OpenBSD, Haiku) +`./cmake/install.sh` +## Windows +You need to create a project (Visual Studio) and add all the source files and dependencies and build yourself. You can use vcpkg to install the dependencies. # Usage -After you have installed sibs, execute `sibs` without any arguments and you will get a list of commands and description for them. +After you have installed sibs, execute `sibs` without any arguments and you will get a list of commands and description for them. For debug builds, the created binary/library files will be located under `sibs-build//debug`. For example on linux x86_64, the path for binaries would be: `sibs-build/linux_x86_64/debug`. + # Package Sibs supports creating a redistributable packages of projects (currently only on Linux, run `sibs package --bundle`). Packaging is in testing phase and may not work for all projects. Currently you need to have python3 and ldd installed and also set the environment variable SIBS_SCRIPT_DIR to scripts sub directory which is in sibs root directory (the directory that contains package.py). Currently a script file is generated which should be used to run the project. The name of the script file is the same as project. This script file will most likely to be removed later. Do NOT run the executable called "program". -- cgit v1.2.3