summaryrefslogtreecommitdiffstats
path: root/build/build-infer/README
diff options
context:
space:
mode:
Diffstat (limited to 'build/build-infer/README')
-rw-r--r--build/build-infer/README36
1 files changed, 36 insertions, 0 deletions
diff --git a/build/build-infer/README b/build/build-infer/README
new file mode 100644
index 0000000000..af11d9af3c
--- /dev/null
+++ b/build/build-infer/README
@@ -0,0 +1,36 @@
+build-infer.py
+==============
+
+A script to build infer from source.
+
+```
+usage: build-infer.py [-h] -c CONFIG [--clean]
+
+optional arguments:
+ -h, --help show this help message and exit
+ -c CONFIG, --config CONFIG
+ infer configuration file
+ --clean Clean the build directory
+```
+
+Pre-requisites
+--------------
+* Working build toolchain.
+* ocam
+* git
+* autoconf
+* libsqlite-dev
+* CMake
+* Ninja
+* Python 2.7
+
+Please use the latest available CMake for your platform to avoid surprises.
+
+Config file format
+------------------
+
+build-clang.py accepts a JSON config format with the following fields:
+
+* infer_revision: The infer revision to build.
+* infer_repo: git repository for infer.
+* patches: Optional list of patches to apply. \ No newline at end of file