diff options
| author | Daniil Baturin <daniil@baturin.org> | 2017-04-03 07:41:17 +0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-04-03 07:41:17 +0700 |
| commit | 5761be1601db95ceeec49104c502902939e194d6 (patch) | |
| tree | e9d4d9823f5d9cab21e1a17e23d1f673926e78b9 | |
| parent | 9cd999ca97788988902913a5d8b86bbd1ac1cf71 (diff) | |
| parent | 82226cd67864ed9c03734b5096fb6dbdcfa69ab1 (diff) | |
| download | vyconf-5761be1601db95ceeec49104c502902939e194d6.tar.gz vyconf-5761be1601db95ceeec49104c502902939e194d6.zip | |
Merge pull request #9 from aBathologist/correct_readme
Make minor corrections to readme
| -rw-r--r-- | README.md | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -74,12 +74,12 @@ For details of the VyConf architecture, see the architecture.md document. ## Hacking -VyConf development is discussed in the (VyOS phabricator)[https://phabricator.vyos.net/project/profile/1/] +VyConf development is discussed in the [VyOS phabricator](https://phabricator.vyos.net/project/profile/1/) and the #vyos IRC channel on Freenode. Don't forget to add unit tests for things you add or change! -If you are new to OCaml, you need to install (opam)[http://opam.ocaml.org/] +If you are new to OCaml, you need to install [opam](http://opam.ocaml.org/) first. Then install the correct version of the compiler, the build tools, and the build dependencies: @@ -93,7 +93,7 @@ To build the project and run the unit tests, do this: ``` ./build-setup.sh -./configure --enable-test +./configure --enable-tests make make test ``` @@ -101,11 +101,11 @@ make test If the project gets in a weird state, and isn't building correctly, you can clean it up with ``` -ocaml setup.ml -dist-clean +ocaml setup.ml -distclean ``` then build as before. - + I also recommend that you setup [utop](https://opam.ocaml.org/blog/about-utop/) (a great interactive REPL) and setup your editor with [merlin](https://github.com/ocaml/merlin) to see the inferred types. For GNU |