Make installation instructions run as shown (#457)
The $ prevented the lines from being copied and run as they are This is fixed now.
This commit is contained in:
parent
5b98d2845b
commit
464cdcbaf7
12
README.md
12
README.md
|
@ -18,7 +18,7 @@ Installation via opam
|
||||||
The easiest and recommended way of installing utop is via
|
The easiest and recommended way of installing utop is via
|
||||||
[opam](https://opam.ocaml.org/):
|
[opam](https://opam.ocaml.org/):
|
||||||
|
|
||||||
$ opam install utop
|
opam install utop
|
||||||
|
|
||||||
If you want to build it manually, refer to the opam file which lists the
|
If you want to build it manually, refer to the opam file which lists the
|
||||||
dependencies.
|
dependencies.
|
||||||
|
@ -28,14 +28,14 @@ Installation from sources
|
||||||
|
|
||||||
To build and install utop:
|
To build and install utop:
|
||||||
|
|
||||||
$ make
|
make
|
||||||
$ make install
|
make install
|
||||||
|
|
||||||
### Documentation and manual pages _(optional)_
|
### Documentation and manual pages _(optional)_
|
||||||
|
|
||||||
To build the documentation (currently broken):
|
To build the documentation (currently broken):
|
||||||
|
|
||||||
$ make doc
|
make doc
|
||||||
|
|
||||||
It will then be installed by `make install`.
|
It will then be installed by `make install`.
|
||||||
|
|
||||||
|
@ -43,14 +43,14 @@ It will then be installed by `make install`.
|
||||||
|
|
||||||
To build and execute tests (currently broken):
|
To build and execute tests (currently broken):
|
||||||
|
|
||||||
$ make test
|
make test
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
-----
|
-----
|
||||||
|
|
||||||
To use utop, simply run:
|
To use utop, simply run:
|
||||||
|
|
||||||
$ utop
|
utop
|
||||||
|
|
||||||
utop display a bar after the prompt which is used to show possible
|
utop display a bar after the prompt which is used to show possible
|
||||||
completions in real-time. You can navigate in it using `M-left` and
|
completions in real-time. You can navigate in it using `M-left` and
|
||||||
|
|
Loading…
Reference in New Issue