Merge branch 'master' of https://github.com/rwols/Clara

README.md

@@ -8,28 +8,35 @@ Semantic C++ code completion for Sublime Text 3
 * `$ cd /path/to/llvm`
 * `$ pushd tools/clang/tools`
 * `$ git clone --recursive https://github.com/rwols/Clara.git`
-* Edit the CMakeLists.txt file in the current directory by adding the line `add_clang_subdirectory(Clara)` to it.
+* Edit the CMakeLists.txt file in the current directory by adding the line 
+ `add_clang_subdirectory(Clara)` to it.
 * `$ popd`
 * `$ mkdir build`
 * `$ cd build`
-* `$ cmake .. -DLLVM_ENABLE_EH=ON -DLLVM_ENABLE_RTTI=ON`
-* `$ make Clara` 
-* This should build a shared library named Clara.so, and all of its dependencies, in the folder lib/
-* To deploy Clara to Sublime Text's packages' folder, do
-* `$ make ClaraInstall`
+* `$ cmake .. -DLLVM_ENABLE_EH=ON -DLLVM_ENABLE_RTTI=ON -DCMAKE_BUILD_TYPE=Release`
+* `$ make ClaraInstall -j8` 
+* This should build and deploy a shared library named Clara.so, and all of its
+ dependencies, to your sublime text packages folder.
 
 # User Guide
-Generate the correct header information: go to the command palette and run the command "Clara: Generate System Headers". This will create a Clara.sublime-settings file in your User preferences directory.
-Clara works best when you have a CMake project and a sublime project. In your top-level CMakeLists.txt file, make sure you have the line
+Generate the correct header information: go to the command palette and run the 
+command "Clara: Generate System Headers". This will create a 
+Clara.sublime-settings file in your User preferences directory. Clara works best
+when you have a CMake project and a sublime project. In your top-level 
+CMakeLists.txt file, make sure you have the line
 
  set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
-somewhere. Then, in your *.sublime-project file, make sure you have at least the following entry:
+somewhere. Then, in your *.sublime-project file, make sure you have at least the
+following entry:
 
  "cmake":
  {
   "build_folder": "${project_path}/build"
  }
 
-alongside "`settings`", "`folders`", "`build_settings`" and whatnot, or whatever the directory is in which you are building your project. This way, Clara will pick up the compile commands for each C++ file, and use that for correct project-wide autocompletion.
-After this, you should be all set. Clara will **not** do auto-completion in header files.
+alongside "`settings`", "`folders`", "`build_settings`" and whatnot, or whatever
+the directory is in which you are building your project. This way, Clara will 
+pick up the compile commands for each C++ file, and use that for correct 
+project-wide autocompletion. After this, you should be all set. Clara will 
+**not** do auto-completion in header files.