Skip to content

Commit 65283c9

Browse files
committed
Update: readme
1 parent 565f3ab commit 65283c9

File tree

1 file changed

+13
-20
lines changed

1 file changed

+13
-20
lines changed

readme.md

+13-20
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,11 @@ To install SMLUnit for [SML/NJ], run `make install` with `Makefile.smlnj`:
6464
$ make -f Makefile.smlnj install
6565
```
6666

67-
To specify the directory to install to, run `make` with the variable `PREFIX`:
67+
Above command install SMLUnit to `/usr/local/sml`.
68+
This install location can be set with `PREFIX` variable like:
6869

6970
```sh
70-
$ make -f Makefile.smlnj install PREFIX=~/.sml/smlnj
71+
$ make -f Makefile.smlnj install PREFIX=~/.sml/smlnj/110.99
7172
```
7273

7374
The `install` target uses [SMLDoc] to generate the documentations for SMLUnit.
@@ -92,7 +93,7 @@ $ echo 'smlunit-lib.cm PREFIX/lib/smlunit-lib.cm' >> ~/.smlnj-pathconfig
9293

9394
#### Test
9495

95-
To run SMLUnit unit tests, run the `test` target:
96+
To run unit tests, run the `test` target:
9697

9798
```sh
9899
$ make -f Makefile.smlnj test
@@ -134,14 +135,13 @@ If you do not need to generate documentation, run the `install-nodoc` target.
134135
$ make -f Makefile.mlton install-nodoc
135136
```
136137

137-
After running the `install` target, add an entry for `SMLUNIT_LIB` to your mlb path mapping file:
138+
After running the `install` target, add an entry for `SMLUNIT_LIB` to your mlb path mapping file to complete the installation.
138139

139140
```sh
140141
$ echo 'SMLUNIT_LIB /path/to/$PREFIX' >> /path/to/mlb-path-map
141142
```
142143

143-
144-
For using SMLUnit, refer to `$(SMLUNIT_LIB)/smlunit-lib.mlb` from your mlbasis file.
144+
For using SMLUnit, refer to `$(SMLUNIT_LIB)/smlunit-lib.mlb` from your MLB file.
145145

146146
```
147147
$(SML_LIB)/basis/basis.mlb
@@ -153,7 +153,7 @@ $(SMLUNIT_LIB)/smlunit-lib.mlb
153153

154154
#### Test
155155

156-
To run SMLUnit unit tests, run the `test` target:
156+
To run unit tests, run the `test` target:
157157

158158
```sh
159159
$ make -f Makefile.mlton test
@@ -164,7 +164,7 @@ Depending on the test case, it will fails.
164164

165165
#### Examples
166166

167-
To run the example program, run `example` target:
167+
To run the example program, run the `example` target:
168168

169169
```sh
170170
$ make -f Makefile.smlnj example
@@ -176,13 +176,14 @@ $ make -f Makefile.smlnj example
176176

177177
#### Install
178178

179-
To install SMLUnit for [Poly/ML], run the `install` target.
179+
To install SMLUnit for [Poly/ML], run `make install` with `Makefile.polyml`.
180180

181181
```sh
182182
$ make -f Makefile.polyml install
183183
```
184184

185-
To specify the directory to install to, run `make` with the variable `PREFIX`:
185+
Above command install SMLUnit to `/usr/local/polyml`.
186+
This install location can be set with `PREFIX` variable like:
186187

187188
```sh
188189
$ make -f Makefile.polyml PREFIX=~/.sml/polyml/5.8.1 install
@@ -212,7 +213,7 @@ val it = (): unit
212213

213214
#### Test
214215

215-
To run SMLUnit unit tests, run the `test` target:
216+
To run unit tests, run the `test` target:
216217

217218
```sh
218219
$ make -f Makefile.polyml test
@@ -226,18 +227,10 @@ Depending on the test case, it will fails.
226227
To run the example program, run the `example` target:
227228

228229
```sh
229-
230230
$ make -f Makefile.polyml example
231-
[POLYML] bin/smlunit-example-poly.o
232-
..
233-
[POLYC] bin/smlunit-example-poly
234-
bin/smlunit-example-poly
235-
.....
236-
tests = 5, failures = 0, errors = 0
237-
Failures:
238-
Errors:
239231
```
240232

233+
241234
[SML/NJ]: https://www.smlnj.org/ "Standard ML of New Jersey"
242235

243236
[MLton]: https://www.mlton.org/ "MLton"

0 commit comments

Comments
 (0)