[doc] Describe the usage flow in the main readme

Ericsson · Dec 1, 2020 · 7e95642 · 7e95642
1 parent 111a982
commit 7e95642
Show file tree

Hide file tree

Showing 3 changed files with 498 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -66,6 +66,25 @@ macOS (OS X) development environment.
     [Eclipse plugin](http://github.com/Ericsson/CodeCheckerEclipsePlugin)
 
 
+# Usage flow
+![Usage diagram](images/usage_flow.png)
+
+- *Step 1*: `CodeChecker log` runs the given build command and records the
+executed compilation steps. These steps are written to an output file
+(Compilation Databases) in a JSON format.
+- *Step 2*: `CodeChecker analyze` uses the previously created JSON Compilation
+Database to perform an analysis on the project, outputting analysis results in
+a machine-readable (plist) format.
+- *Step 3*: in this step you can do multiple things:
+    - Parse and pretty-print the summary and results from analysis result files
+    (`CodeChecker parse`).
+    - Store the results to a running CodeChecker server (`CodeChecker store`).
+    - Compare two analysis results/runs to show the results that differ between
+    the two (`CodeChecker cmd diff`).
+    - etc.
+
+For more information how to use CodeChecker see our [user guide](usage.md).
+
 # User documentation
 
 * [Getting started (How-To with examples)](usage.md)

diff --git a/docs/images/usage_flow.png b/docs/images/usage_flow.png