Update README.md

This commit is contained in:
Jacob Dufault 2017-04-25 13:45:08 -07:00 committed by GitHub
parent 592ef1c3cf
commit 1b2219f509

View File

@ -52,6 +52,28 @@ If you run into issues, you can view debug output by running the
## Project setup
### System includes
cquery will likely fail to resolve system includes like `<vector>` unless the include path is updated to point to them. Add the system include paths to `cquery.extraClangArguments`. For example,
```js
{
// ...
"cquery.extraClangArguments": [
// Generated by running the following in a Chrome checkout:
// $ ./third_party/llvm-build/Release+Asserts/bin/clang++ -v ash/debug.cc
"-isystem/usr/lib/gcc/x86_64-linux-gnu/4.8/../../../../include/c++/4.8",
"-isystem/usr/lib/gcc/x86_64-linux-gnu/4.8/../../../../include/x86_64-linux-gnu/c++/4.8",
"-isystem/usr/lib/gcc/x86_64-linux-gnu/4.8/../../../../include/c++/4.8/backward",
"-isystem/usr/local/include",
"-isystem/work/chrome/src/third_party/llvm-build/Release+Asserts/lib/clang/5.0.0/include",
"-isystem/usr/include/x86_64-linux-gnu",
"-isystem/usr/include",
],
// ...
}
```
### compile_commands.json (Best)
To get the most accurate index possible, you can give cquery a compilation