Skip to content

Commit 7dbeaeb

Browse files
committed
Update readme.
1 parent 3975032 commit 7dbeaeb

1 file changed

Lines changed: 6 additions & 9 deletions

File tree

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,17 @@ make clean # clean the compiled artifacts
3030
A single test file `./src/test.re` is included. Make a simple change to it and
3131
then run the commands above to see it effect the output.
3232

33-
The built output is in `_build`. Try running it with `_build/src/test.native`.
33+
The built output is in `_build` but the final binary is symlinked `_build/src/index.native -> index.native`.
3434

3535
## Developing Your Project
3636

37-
`ReasonNativeProject` is meant to be the starting point of your own project. You'll
38-
want to make use of existing libraries in your app, so browse the growing set
39-
of `opam` packages in the [opam repository](http://opam.ocaml.org/packages/).
37+
`ReasonNativeProject` is meant to be the starting point of your own project. You'll want to make use of existing libraries in your app, so browse the growing set of `opam` packages in the [opam repository](http://opam.ocaml.org/packages/).
4038

4139
##### Add Another Dependency
4240

43-
Edit your `opam` file so that you depend on a particular opam package and range
44-
of versions.
41+
While developing you can simply modify the `_tags` file which is what `rebuild uses to figure out what you depend on. See inside that file for more instructions.
42+
43+
Before publishing onto opam you'll need to edit your `opam` file so that you depend on a particular opam package and range of versions.
4544

4645
In addition you may have to tweak the buildstep to recognize the dependency, by changing `build.ml` within the `pkg` folder. and add the following for you dependency:
4746
```ocaml
@@ -65,6 +64,4 @@ See the [OPAM instructions](https://opam.ocaml.org/doc/Packaging.html).
6564

6665
## Troubleshooting
6766

68-
In general, if something goes wrong, try upgrading your install of the project
69-
by running `opam upgrade ReasonNativeProject`, or if it failed to install and you
70-
later fixed it, `opam install ReasonNativeProject`.
67+
In general, if something goes wrong, try upgrading your install of the project by running `opam upgrade ReasonNativeProject`, or if it failed to install and you later fixed it, `opam install ReasonNativeProject`.

0 commit comments

Comments
 (0)