Skip to content

Commit

Permalink
README.md: Link to chapter below
Browse files Browse the repository at this point in the history
  • Loading branch information
guruz committed Aug 9, 2016
1 parent e143bf0 commit 4af3f47
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ make
Using the generator
===================

Step 1: Generate the compile_commands.json for your project
Step 1: Generate the compile_commands.json (see chapter "Compilation Database" below) for your project

The code browser is built around the clang tooling infrastructure that uses compile_commands.json
http://clang.llvm.org/docs/JSONCompilationDatabase.html
Expand Down Expand Up @@ -170,8 +170,10 @@ codebrowser_indexgenerator <output_dir> [-d data_url] [-p project_definition]
default to ../data relative to the output dir
example: -d https://code.woboq.org/data

Compilation Database
====================


Compilation Database (compile_commands.json)
============================================
The generator is a tool which uses clang's LibTooling. It needs either a
compile_commands.json or the arguments to be passed after '--' if they are
the same for every file.
Expand Down

0 comments on commit 4af3f47

Please sign in to comment.