diff options
| author | dec05eba <dec05eba@protonmail.com> | 2018-10-10 04:56:05 +0200 |
|---|---|---|
| committer | dec05eba <dec05eba@protonmail.com> | 2020-07-06 07:39:33 +0200 |
| commit | 6b238d4bc3c142f6337a73d858e069cae778dc54 (patch) | |
| tree | ac49caf83291f9738f7f453d184ec78394ff90a3 | |
| parent | 0073788bfead1239d563e93f60dc8021bbf3dfaf (diff) | |
Update README with info about IDE support
| -rw-r--r-- | README.md | 5 | ||||
| -rw-r--r-- | preview.png | bin | 0 -> 319920 bytes |
2 files changed, 3 insertions, 2 deletions
@@ -54,8 +54,9 @@ 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. 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. +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 or cquery. To generate compile_commands.json that also finds header files (non-relative) you need to have compdb installed and available 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. I recommend using Visual Studio Code along with cquery (https://github.com/cquery-project/cquery/wiki), which gives you very good IDE support for your C/C++ projects: + # 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 diff --git a/preview.png b/preview.png Binary files differnew file mode 100644 index 0000000..e5c7234 --- /dev/null +++ b/preview.png |
