From 963470d28def5c7e54e8b121dc550183a7f23c1d Mon Sep 17 00:00:00 2001 From: dec05eba Date: Sat, 5 Feb 2022 21:32:20 +0100 Subject: Update readme with info about pkg-config and how to use sibs with dependencies --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8bdf058..56ee9b2 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,10 @@ 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//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//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`. # 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`. -- cgit v1.2.3