Skip to content

docs: add local development quickstart to README (fixes #1926) #1934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aryanrahar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add local development quickstart to README (fixes #1926) #1934

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,38 @@ Started](http://fbinfer.com/docs/getting-started) page for
details on how to install packaged versions of Infer. To build Infer
from source, see [INSTALL.md](./INSTALL.md).

### Local development quickstart

```sh
./build-infer.sh
make devsetup
make -j # default BUILD_MODE=dev (treat warnings as errors)
make -j test_build # quick sanity check
make -j4 test # run tests (adjust 4 to your CPU cores)
```

Faster OCaml inner loop:

```sh
make -j -C infer/src check # type-check only
make -j -C infer/src byte # fast bytecode build for small examples
```

Temporarily ignore warnings while iterating (clean up before committing):

```sh
make BUILD_MODE=dev-noerror -j
```

Analyze a project you build with Make or Maven:

```sh
infer run -- make <target>
infer run -- mvn <target>
```

See [INSTALL.md](./INSTALL.md) for platform-specific details and the website docs for wrapping real builds.

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md).
Expand All @@ -22,5 +54,3 @@ Infer is MIT-licensed.

Note: Enabling Java support may require you to download and install
components licensed under the GPL.