[docs] update docs

Summary: Some minor updating needed.

Reviewed By: akotulski

Differential Revision: D4204564

fbshipit-source-id: 742238e
master
Jules Villard 9 years ago committed by Facebook Github Bot
parent 86cb2f4938
commit 350fe4d42c

@ -9,12 +9,9 @@ us a line at cla@fb.com. Thanks!
## Submitting Pull Requests ## Submitting Pull Requests
* Please make sure Infer builds: `make -C infer clean <target>`. Refer * Please make sure Infer builds: `make`. Refer to the [installation
to the [installation
document](https://github.com/facebook/infer/blob/master/INSTALL.md) document](https://github.com/facebook/infer/blob/master/INSTALL.md)
for details. for details.
* If relevant, add a test for your change. Tests are located at * If relevant, add a test for your change. Tests are located in
`infer/tests/codetoanalyze/` and `infer/tests/`. To run the all tests, execute `make test`.
`infer/tests/{endtoend,frontend}/`. To run the all tests, execute
`make test`.

@ -31,7 +31,7 @@ You can install some of these dependencies using
```sh ```sh
brew install autoconf automake opam caskroom/cask/brew-cask && \ brew install autoconf automake opam caskroom/cask/brew-cask && \
brew cask install caskroom/versions/java7 brew cask install java7
``` ```
@ -86,8 +86,10 @@ some means other than opam, you can still compile Infer by running:
./autogen.sh ./autogen.sh
./configure ./configure
make # or make java make # or make java
# Install Infer into your PATH # Install Infer into your PATH...
export PATH=`pwd`/infer/bin:$PATH export PATH=`pwd`/infer/bin:$PATH
# ...or, alternatively, install Infer system-wide
sudo make install
``` ```
@ -168,14 +170,8 @@ sudo update-alternatives \
### Setting up opam ### Setting up opam
Unfortunately, the version of opam that ships with some Linux Unfortunately, the version of opam that ships with some Linux
distributions is broken, so you'll have to get it from the web: distributions is broken, so you'll have to get it from the
[web](http://opam.ocaml.org/doc/Install.html#Binarydistribution).
```sh
wget https://github.com/ocaml/opam/releases/download/1.2.2/opam-1.2.2-x86_64-Linux
chmod +x opam-1.2.2-x86_64-Linux
sudo cp opam-1.2.2-x86_64-Linux /usr/local/bin/opam
opam init --comp=4.02.3
```
Alternatively, follow the instructions [from the opam The OCaml dependencies needed by Infer are automatically handled by
webpage](https://opam.ocaml.org/doc/Install.html). opam when running `./build-infer.sh`.

Loading…
Cancel
Save