From 0073788bfead1239d563e93f60dc8021bbf3dfaf Mon Sep 17 00:00:00 2001 From: dec05eba Date: Mon, 8 Oct 2018 15:15:43 +0200 Subject: Use compdb tool to include header files in compile_commands.json --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index ab43024..8312fc7 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Cross compilation currently only works from linux64 to win64 by using mingw-w64. 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`. # 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. +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. To generate compile_commands.json that also finds header files (non-relative) you need to have compdb installed and availabile in your PATH environment variable: https://github.com/Sarcasm/compdb 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. -- cgit v1.2.3