diff --git a/INSTALL.md b/INSTALL.md index f812aa59c..7ba701b87 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,18 +1,14 @@ -# How to compile and install Infer +# How to install Infer from source -## Pre-compiled versions +## Pre-compiled clang versions We provide a source release of Infer packaged with pre-build binaries for clang and facebook-clang-plugins for Linux and MacOS. We encourage you to use this release as compiling clang is time-consuming. Install the dependencies as explained in the next section, then follow the -instructions in [Infer's getting-started -page](http://fbinfer.com/docs/getting-started.html) to compile and -install Infer. - -Alternatively, we also provide a docker image in the docker/ -directory. Simply go to that directory and run `./run.sh` to get -started with a working installation of Infer. +instructions in our [Getting +Started](http://fbinfer.com/docs/getting-started.html#install-from-source) +page to compile and install Infer. ## Infer dependencies for MacOSX diff --git a/README.md b/README.md index 4d3294e30..8669a07f3 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@ -Infer -===== +# Infer -Infer is a static analysis tool for Java, Objective-C and C, written in [OCaml](https://ocaml.org/). -Check out the documentation at . -See [FILES.md](FILES.md) for a quick overview of the files in `infer/bin`. +[Infer](http://fbinfer.com/) is a static analysis tool for Java, +Objective-C and C, written in [OCaml](https://ocaml.org/). -Installation ------------- -Read the [INSTALL.md](INSTALL.md) file for details on installing Infer. +## Installation + +Read our [Getting +Started](http://fbinfer.com/docs/getting-started.html) page for +details on how to install packaged versions of Infer. To build Infer +from source, see INSTALL.md. -License -------- -Infer is BSD-licensed. We also provide an additional patent grant. +## License + +Infer is BSD-licensed. We also provide an additional patent grant.