Zengtudor/ccls
1
0
Fork 0
mirror of https://github.com/MaskRay/ccls.git synced 2024-11-25 00:55:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated Build (markdown)

Fangrui Song 2018-03-31 00:02:19 -07:00
parent 4065e185a3
commit 92590449a4
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Build.md

@ -1,6 +1,6 @@
cquery has experimental support for the CMake build system. ccls has experimental support for the CMake build system.
To get started building cquery, first install the required dependencies: To get started building ccls, first install the required dependencies:
* CMake 3.1 or higher * CMake 3.1 or higher
* C++ Compiler with C++14 support: * C++ Compiler with C++14 support:
@ -10,9 +10,9 @@ To get started building cquery, first install the required dependencies:
After installing the required dependencies, clone the repository along with its After installing the required dependencies, clone the repository along with its
git submodules using: git submodules using:
`git clone https://github.com/cquery-project/cquery.git --recursive` `git clone https://github.com/ccls-project/cquery.git --recursive`
After cloning the repository, open a terminal and navigate to the cquery After cloning the repository, open a terminal and navigate to the ccls
directory. Then, create a build directory which will contain all files directory. Then, create a build directory which will contain all files
related to the build. Enter the build directory. related to the build. Enter the build directory.
@ -25,10 +25,10 @@ cmake invocation (`cmake -DCMAKE_GENERATOR_PLATFORM=x64 ..`). 32-bit builds
are not supported at the moment. are not supported at the moment.
This command generates project files for your system's default generator (Linux: This command generates project files for your system's default generator (Linux:
make, Windows: MSBuild). CMake defaults to a Release build and links cquery make, Windows: MSBuild). CMake defaults to a Release build and links ccls
against the libclang library which it downloads from https://releases.llvm.org. against the libclang library which it downloads from https://releases.llvm.org.
After CMake configuration cquery can be built from inside the build directory by After CMake configuration ccls can be built from inside the build directory by
executing the corresponding generator command (Linux: `make`, Windows: executing the corresponding generator command (Linux: `make`, Windows:
`MSBuild.exe`) or the generic CMake build command (`cmake --build .`) `MSBuild.exe`) or the generic CMake build command (`cmake --build .`)
@ -36,7 +36,7 @@ executing the corresponding generator command (Linux: `make`, Windows:
CMake options can be specified when running CMake to change its behaviour. CMake options can be specified when running CMake to change its behaviour.
Options are passed to CMake via the command line by prepending them with -D. For Options are passed to CMake via the command line by prepending them with -D. For
example: `cmake -DCMAKE_BUILD_TYPE=Debug ..` configures cquery to be built in example: `cmake -DCMAKE_BUILD_TYPE=Debug ..` configures ccls to be built in
release mode. release mode.
* `-DCMAKE_BUILD_TYPE=(Debug|Release)` * `-DCMAKE_BUILD_TYPE=(Debug|Release)`
@ -44,9 +44,9 @@ release mode.
`CMAKE_BUILD_TYPE` can be used to set the build type. There are a few possible `CMAKE_BUILD_TYPE` can be used to set the build type. There are a few possible
options, but the most important ones are Debug and Release. Generally you want options, but the most important ones are Debug and Release. Generally you want
to pass `-DCMAKE_BUILD_TYPE=Release` to CMake to get the best performance out of to pass `-DCMAKE_BUILD_TYPE=Release` to CMake to get the best performance out of
cquery. Debug is recommended when debugging cquery with a debugger. Since cquery ccls. Debug is recommended when debugging cquery with a debugger. Since cquery
defaults to a Release build it usually isn't necessary to define this option defaults to a Release build it usually isn't necessary to define this option
unless you're debugging an issue in cquery with a debugger. unless you're debugging an issue in ccls with a debugger.
* `-DSYSTEM_CLANG=(ON|OFF)` * `-DSYSTEM_CLANG=(ON|OFF)`