From 03e3ceb71fd27f8f026530c2f1c5009e32b15b01 Mon Sep 17 00:00:00 2001 From: Dulma Rodriguez Date: Tue, 9 Jun 2015 19:23:07 -0100 Subject: [PATCH] Adding docs about the files in bin --- INSTALL.md | 24 +++++++++++++++--------- README.md | 5 +++-- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 9c356d0b5..a68b3ef88 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -4,16 +4,20 @@ We provide pre-built Infer binaries for Linux and MacOS. If you just wish to use Infer, and are not interested in making contributions to it, then these binaries are all you need. Otherwise, if you wish to compile Infer, here are also instructions to do so, depending on your operating system. -- [Install the Infer binaries](INSTALL.md#Install-the-Infer-binaries) - - [Mac OS X](INSTALL.md#Mac-OS-X) - - [Linux](INSTALL.md#Linux) -- [Install Infer from source](INSTALL.md#Install-Infer-from-source) - - [Download Infer](INSTALL.md#Download-Infer) - - [Mac OS X](INSTALL.md#Mac-OS-X) - - [Linux](INSTALL.md#Linux) +- [Install the Infer binaries](INSTALL.md#install-the-infer-binaries) + - [Mac OS X](INSTALL.md#mac-os-x) + - [Linux](INSTALL.md#linux-64-bit) +- [Install Infer from source](INSTALL.md#install-infer-from-source) + - [Download Infer](INSTALL.md#download-infer) + - [Mac OS X](INSTALL.md#macos-x) + - [Linux](INSTALL.md#linux) ##Install the Infer binaries +###Requirements + +- Python 2.7 + ###Mac OS X Get the latest `infer-osx-vXX.tar.xz` from [infer releases](https://github.com/facebook/infer/releases) and run the commands below in your terminal to install Infer. @@ -43,6 +47,10 @@ echo "export PATH=$PATH:`pwd`/infer-0.1-x64-linux/infer/infer/bin" \ The following instructions describe how to compile Infer on different platforms. +###Requirements + +- Python 2.7 + ### Download the Infer repository git clone https://github.com/facebook/infer.git @@ -59,12 +67,10 @@ To analyse C and ObjC, Infer requires clang and the [facebook-clang-plugin](http - `Java <= 1.7` - Android dev setup for analysis of Android apps. - ##### Requirements for C/ObjC analysis - `XCode <= 6.3, >= 6.1` - `clang` (XCode command line tools. You can install them with the command `xcode-select --install`) - ###Installation instructions Install OCaml dependencies: diff --git a/README.md b/README.md index 55f61e4e9..84b06ac61 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ Infer ===== -Infer is a static analysis tool for Java and C / Objective C. -To see what it can do for you, check out the documentation at . +Infer is a static analysis tool for Java, Objective-C and C, written in [OCaml](https://ocaml.org/). +To see what it can do for you, check out the documentation at . +Check out [FILES.md](FILES.md) for a quick overview of the files in `infer/bin`. Installation ------------