Skip to content

Commit 986fb5e

Browse files
authored
Merge pull request #4955 from rescript-lang/cleanup
split ReadME into credits.md
2 parents 891cc36 + 3ead99a commit 986fb5e

File tree

2 files changed

+34
-29
lines changed

2 files changed

+34
-29
lines changed

Credits.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Credits
2+
3+
ReScript builds on parts of OCaml:
4+
5+
* [`jscomp/core/lam_pass_exits.ml`](jscomp/core/lam_pass_exits.ml)
6+
* [`jscomp/core/lam_pass_lets_dce.ml`](jscomp/core/lam_pass_lets_dce.ml)
7+
8+
These modules were adapted from [`ocaml/bytecomp/simplif.ml`](ocaml/bytecomp/simplif.ml) for
9+
JavaScript specific optimization purposes.
10+
11+
* [`jscomp/main/js_main.ml`](jscomp/main/js_main.ml)
12+
13+
`jscomp/main/js_main.ml` is adapted from [`ocaml/driver/main.ml`](ocaml/driver/main.ml). It is the main entry
14+
point of the underlying compiler.
15+
16+
* [`jscomp/stdlib-406`](jscomp/stdlib-406)
17+
18+
`jscomp/stdlib-*` is copied from [`ocaml/stdlib`](ocaml/stdlib). It is compiled to JavaScript and included with ReScript.
19+
20+
ReScript imported one file from [jsoo](https://github.com/ocsigen/js_of_ocaml)
21+
22+
* [`jscomp/core/js_dump.ml`](jscomp/core/js_dump.ml) (pretty printer)
23+
24+
This file was imported but changed significantly in iterations later.
25+
26+
* [`jscomp/test`](jscomp/test)
27+
28+
`jscomp/test` is based on [`ocaml/testsuite`](ocaml/testsuite).
29+
30+
ReScript unit test builds on parts of [OUnit](http://ounit.forge.ocamlcore.org/)
31+
32+
* [`jscomp/ounit`](jscomp/ounit) is adapted from ounit, the unit test
33+
utilities are only used for dev purpose, they are not required for distribution

README.md

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -30,32 +30,4 @@ Refer to its copyright and license notices for information about its licensing.
3030
The `vendor/ninja.tar.gz` contains the vendored [ninja](https://github.com/ninja-build/ninja).
3131
Refer to its copyright and license notices for information about its licensing.
3232

33-
ReScript builds on parts of [js_of_ocaml](https://github.com/ocsigen/js_of_ocaml):
34-
35-
* [`jscomp/core/js_dump.ml`](jscomp/core/js_dump.ml) (pretty printer)
36-
37-
ReScript builds on parts of OCaml:
38-
39-
* [`jscomp/core/lam_pass_exits.ml`](jscomp/core/lam_pass_exits.ml)
40-
* [`jscomp/core/lam_pass_lets_dce.ml`](jscomp/core/lam_pass_lets_dce.ml)
41-
42-
These modules were adapted from [`ocaml/bytecomp/simplif.ml`](ocaml/bytecomp/simplif.ml) for
43-
JavaScript specific optimization purposes.
44-
45-
* [`jscomp/main/js_main.ml`](jscomp/main/js_main.ml)
46-
47-
`jscomp/main/js_main.ml` is adapted from [`ocaml/driver/main.ml`](ocaml/driver/main.ml). It is the main entry
48-
point of the underlying compiler.
49-
50-
* [`jscomp/stdlib-406`](jscomp/stdlib-406)
51-
52-
`jscomp/stdlib-*` is copied from [`ocaml/stdlib`](ocaml/stdlib). It is compiled to JavaScript and included with ReScript.
53-
54-
* [`jscomp/test`](jscomp/test)
55-
56-
`jscomp/test` is based on [`ocaml/testsuite`](ocaml/testsuite).
57-
58-
ReScript unit test builds on parts of [OUnit](http://ounit.forge.ocamlcore.org/)
59-
60-
* [`jscomp/ounit`](jscomp/ounit) is adapted from ounit, the unit test
61-
utilities are only used for dev purpose, they are not required for distribution
33+
See [Credits](./Credits.md) for more details.

0 commit comments

Comments
 (0)