diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 18 insertions, 6 deletions
@@ -29,7 +29,7 @@ cd project-name # Build the project in debug mode and run it sibs run # To compile with optimizations enabled, run: -# sibs build --release +sibs build --release # and then the output binary is available in sibs-build/<platform-name>/release/project-name ``` @@ -67,7 +67,12 @@ On Arch Linux, sibs can alternatively be found on aur under the name `sibs-git` ## Windows Use vcpkg to install the required dependencies and then generate visual studio (or another system) build files using CMakeLists.txt # Usage -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/<platform>/debug`. For example on linux x86_64, the path for binaries would be: `sibs-build/linux_x86_64/debug`. +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/<platform>/debug`. For example on linux x86_64, the path for binaries would be: `sibs-build/linux_x86_64/debug`.\ +The current recommended way of using sibs is to add dependencies as git submodules and they will automatically be used. To use system dependencies use pkg-config.\ +You can list all your system packages with `pkg-config --list-all` (if the packages provide pkg-config files). To search for a package in this list you can use grep, like so: `pkg-config --list-all | grep 'pkg-name'` (replace pkg-name with the name of the package you want to search for).\ +To then show the version of the found package you can use `pkg-config --modversion pkg-name`. + +sibs will prefer mold linker in release mode if it's available and then the lld linker and then the gold linker. You can install mold/lld to improve compile times. Note that gdb debugging is a bit buggy when using mold/lld so use of mold/lld is only recommended in release mode. # Quirks 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`. @@ -87,9 +92,9 @@ Users are required to manually install some libraries as they can't be included This requirement might be removed later, if the gpu driver libraries required can somehow be detected and downloaded cross platform. Libraries that are downloaded are available at: https://github.com/DEC05EBA/libraries # Cross compilation -Automatic cross compilation (`sibs build --platform <platform>`)currently only works from linux_x86_64 to win64 by using mingw-w64. You need to install `mingw-w64-gcc` and optionally `mingw-w64-pkg-config` if you want to use mingw-w64 system installed packages. +Automatic cross compilation (`sibs build --platform <platform>`) currently only works from linux_x86_64 to win64 by using mingw-w64. You need to install `mingw-w64-gcc` and optionally `mingw-w64-pkg-config` if you want to use mingw-w64 system installed packages. Cross compilation does currently not work if you have zig files as zig doesn't support libc when cross compiling at the moment. -You can run `scripts/mingw_package.py` to automatically copy dynamic library dependencies of your executable to the same directory as the executable, so the library can be found when running the executable on windows; this also allows you to bundle your application and distribute it without external dependencies. To run `scripts/mingw_package.py` you need to install pefile python library `sudo pip install pefile`. +You can run `scripts/mingw_package.py` to automatically copy dynamic library dependencies of your executable to the same directory as the executable, so the library can be found when running the executable on windows; this also allows you to bundle your application and distribute it without external dependencies. To run `scripts/mingw_package.py` you need to install pefile python library: `sudo pip install pefile`. Manual cross compilation can be done by replacing c, c++ compilers and static library archiver (ar) using the environment variable CC, CXX and AR. # IDE support @@ -116,6 +121,7 @@ version = "c11" [lang.cpp] version = "c++14" +enable_exceptions = "true" [define] BOOST_ASIO_SEPERATE_COMPILATION = "1" @@ -194,8 +200,14 @@ The best way to do this is to create another git project for the dependency and Using sub projects allows you to modify dependency and propagate changes to dependant project without pushing changes to remote git repository (faster development). ## lang.* Optional. Allows you to change language specific configuration. \[lang.c] is for C and \[lang.cpp] is for C++. -Version specifies the language version, for \[lang.c] the version can be ansi (alias for c89), c89, c99 or c11 - if not set, c11 will be used. -For \[lang.cpp] the version can be c++11, c++14 or c++17 - if not set, c++14 will be used +## lang.c +### version +Optional. The c standard version to use. Should be either ansi (alias for c89), c89, c99, c11 or c17. The default value is c11. +## lang.cpp +### version +Optional. The c++ standard version to use. Should be either c++03, c++98, c++11, c++14, c++17 or c++20. The default value is c++14. +### enable_exceptions +Optional. This option should be either "true" or "false" and specifies if exceptions should be enabled for the project. The default value is "true". ## define Optional. A list of definitions which are specified in name-value pairs where the name is the preprocessor to define (in c: #define name value) ## define.static |