From 4af3f476036ea5473c9c3d7b67aa23aa098ee6bf Mon Sep 17 00:00:00 2001 From: Markus Goetz Date: Tue, 9 Aug 2016 14:58:50 +0200 Subject: [PATCH] README.md: Link to chapter below --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d264035..d58e47d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -170,8 +170,10 @@ codebrowser_indexgenerator [-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.