summaryrefslogtreecommitdiffstats
path: root/development/Bear/README
diff options
context:
space:
mode:
Diffstat (limited to 'development/Bear/README')
-rw-r--r--development/Bear/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/development/Bear/README b/development/Bear/README
new file mode 100644
index 0000000000..000b651b9f
--- /dev/null
+++ b/development/Bear/README
@@ -0,0 +1,9 @@
+Bear is a tool that generates a compilation database for clang tooling.
+
+The JSON compilation database is used in the clang project to provide
+information on how a single compilation unit is processed. With this, it
+is easy to re-run the compilation with alternate programs.
+
+Some build system natively supports the generation of JSON compilation
+database. For projects which does not use such build tool, Bear
+generates the JSON file during the build process.