aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2018-10-02 00:57:25 +0200
committerdec05eba <dec05eba@protonmail.com>2020-07-06 07:39:33 +0200
commit40aaca3b078ec46d18cf3569c45ef4a46f508ca8 (patch)
treed8950f8288c015b08c909a4f697e43ea51641cff
parentc206fd07db07dc6271185dabac822e10d78b4443 (diff)
Update README with usage info
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index cb7158b..a8e02b5 100644
--- a/README.md
+++ b/README.md
@@ -35,9 +35,11 @@ Dependencies that are required to build sibs from source are:
`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.
+# Usage
+After you have installed sibs, execute `sibs` without any arguments and you will get a list of commands and description for them.
# 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.
+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.
# Tests
If your project contains a sub directory called "tests" then that directory will be used a test project. The test directory may contain a project.conf file which can contain \[dependencies] block for specifying test only dependencies. The test automatically includes the parent project as a dependency.
# Project configuration template