Skip to content
Permalink
Browse files

[INSTALL, CONTRIBUTING] Move out some advanced instrs

Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
  • Loading branch information
artagnon committed Jul 26, 2019
1 parent 483c968 commit adff8d7cd44752bd40f8eb18d1f7b0d5bc2597f8
Showing with 12 additions and 8 deletions.
  1. +11 −1 CONTRIBUTING.md
  2. +1 −7 INSTALL.md
@@ -5,7 +5,7 @@ collaboration model meant to attract contributions from a broad and
growing community, which includes various companies, universities,
research institutes, and individuals.

The code of F* is released under the permissive Apache v2.0 License
The code of F* is released under the permissive Apache v2.0 License
and is developed at https://github.com/FStarLang/FStar

# Contributor License Agreement
@@ -78,6 +78,16 @@ message on a pull request after each build, with a link to publicly-hosted logs
(they exist! ask a reviewer about them if you need them) along with a full
report on the aforementioned "Success with breakages" builds.

NOTE: If you're developing a part of F\* that changes the OCaml output, you could get stuck due to a dirty worktree; in that case, run:

```
$ git clean -dfx
$ git checkout -- src/ocaml-output
$ make -C src -j6 ocaml-fstar-ocaml
```

Caution: You might want to run `git clean -dfx` only in certain subdirectories, not the entire tree.

# Reviewers of pull requests

To help the review process, and reduce turnaround time, it helps
@@ -162,13 +162,7 @@ See [Running F\* from a docker image](https://github.com/FStarLang/FStar/wiki/Ru

## Building F\* from sources ##

Short version: Simply run `make -C src -j6 ocaml-fstar-ocaml` from the `master` branch of the clone. If you're developing a part of F\* that changes the OCaml output, you could get stuck due to a dirty worktree; in that case, run:

```
$ git clean -dfx
$ git checkout -- src/ocaml-output
$ make -C src -j6 ocaml-fstar-ocaml
```
Short version: Simply run `make -C src -j6 ocaml-fstar-ocaml` from the `master` branch of the clone.

If you have a serious interest in F\* or want to report bugs then we recommend that you build F\* from the sources on GitHub (the `master` branch).

0 comments on commit adff8d7

Please sign in to comment.
You can’t perform that action at this time.