From 4b8214854b5d7aa7033d91438edc50a48598b774 Mon Sep 17 00:00:00 2001 From: dec05eba Date: Tue, 2 Oct 2018 21:27:46 +0200 Subject: Update README with package info --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index a8e02b5..13051ed 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,8 @@ Dependencies that are required to build sibs from source are: 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. # Usage After you have installed sibs, execute `sibs` without any arguments and you will get a list of commands and description for them. +# Package +Sibs supports creating a redistributable packages of projects (currently only on Linux, recommended to use --bundle option). Packaging is in testing phase and may not work. Currently you need to have ldd and patchelf 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). # IDE support Sibs generates a compile_commands.json in the project root directory when executing `sibs build` and tools that support clang completion can be used, such as YouCompleteMe. There are several editors that support YouCompleteMe, including Vim, Emacs and Visual Studio Code. Visual studio code now also supports clang completion with C/C++ extension by Microsoft; the extension will ask you which compile_commands.json file you want to use and you can choose the compile_commands.json in the project root directory. -- cgit v1.2.3