Skip to content

Commit 8e3ccc6

Browse files
cknittcknitt
authored
New README (#5586)
1 parent ac3744a commit 8e3ccc6

File tree

2 files changed

+119
-34
lines changed

2 files changed

+119
-34
lines changed

‎CREDITS.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
1-
# Credits
1+
# History
22

3-
ReScript builds on parts of OCaml:
3+
This project was originally created by [Hongbo Zhang](https://github.com/bobzhang) in 2015. It was named BuckleScript and rebranded into [ReScript](https://rescript-lang.org/) in 2020.
4+
5+
The major contributions from contributors include
6+
7+
- `super_errors` from [Cheng](https://github.com/chenglou) and [Cristiano](https://github.com/cristianoc)
8+
- `react_jsx_ppx` from [Ricky](https://github.com/rickyvetter)
9+
10+
Cristiano also contributed to several important patches in the upstream native compiler,
11+
in particular, the pattern match compilation.
12+
13+
More details are available [here](https://github.com/rescript-lang/rescript-compiler/graphs/contributors).
14+
15+
# Acknowledgments
16+
17+
## OCaml
18+
19+
Thanks to the [OCaml](https://ocaml.org) team, obviously, without such a beautiful yet practical language, this project would not exist.
20+
21+
ReScript builds on these parts of OCaml:
422

523
- [`jscomp/core/lam_pass_exits.ml`](jscomp/core/lam_pass_exits.ml)
624
- [`jscomp/core/lam_pass_lets_dce.ml`](jscomp/core/lam_pass_lets_dce.ml)
@@ -31,3 +49,11 @@ ReScript unit test builds on parts of [OUnit](http://ounit.forge.ocamlcore.org/)
3149

3250
- [`jscomp/ounit`](jscomp/ounit) is adapted from ounit, the unit test
3351
utilities are only used for dev purpose, they are not required for distribution
52+
53+
## Ninja
54+
55+
Thanks to [ninja-build](https://ninja-build.org), ReScript also comes with a blazing fast build tool on top of it, `ninja` is a truly [well engineered](http://aosabook.org/en/posa/ninja.html) scalable build tool.
56+
57+
## Bloomberg and Facebook
58+
59+
Thanks to [Bloomberg](https://www.techatbloomberg.com) and [Facebook](https://github.com/facebook/). This project began at Bloomberg and was published in 2016; without the support of Bloomberg, it would not have happened. This project's funded by Facebook since July 2017.

‎README.md

Lines changed: 91 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,114 @@
1-
<div align="center">
1+
<h1 align="center">
2+
<a href="https://rescript-lang.org/">
3+
ReScript
4+
</a>
5+
</h1>
26

3-
<h3> <a href="https://rescript-lang.org"> ReScript Documentation </a> | <a href="https://forum.rescript-lang.org/"> Forum </a> | <a href="https://rescript-lang.org.cn/community/roadmap#roadmap"> Roadmap</a> | <a href="https://rescript-lang.org.cn/"> 中文 </a> | <a href="https://green-labs.github.io/rescript-in-korean/"> 한국어 </a> </h3>
4-
5-
</div>
7+
<p align="center">
8+
<strong>Fast, Simple, Fully Typed JavaScript from the Future.</strong>
9+
</p>
610

7-
## Overview
11+
<p align="center">
12+
<a href="https://www.npmjs.org/package/rescript">
13+
<img src="https://img.shields.io/npm/v/rescript?color=brightgreen&label=npm%20package" alt="Current npm package version." />
14+
</a>
15+
<a href="https://github.com/rescript-lang/rescript-compiler/actions">
16+
<img src="https://github.com//rescript-lang/rescript-compiler/workflows/CI/badge.svg" alt="Current Github Actions workflow status." />
17+
</a>
18+
<a href="https://github.com/rescript-lang/rescript-compiler/blob/HEAD/LICENSE">
19+
<img src="https://img.shields.io/badge/License-LGPL%20v3-blue.svg" alt="ReScript is released under the LGPL license." />
20+
</a>
21+
<a href="https://twitter.com/intent/follow?screen_name=rescriptlang">
22+
<img src="https://img.shields.io/twitter/follow/rescriptlang.svg?label=Follow%20@rescriptlang" alt="Follow @rescriptlang" />
23+
</a>
24+
</p>
825

9-
The compiler for ReScript: a statically typed functional language focused on shipping.
26+
<h3 align="center">
27+
<a href="https://rescript-lang.org/docs/manual/latest/introduction">Introduction</a>
28+
<span> · </span>
29+
<a href="https://rescript-lang.org/docs/manual/latest/installation">Installation</a>
30+
<span> · </span>
31+
<a href="https://rescript-lang.org/try">Try Online</a>
32+
<span> · </span>
33+
<a href="https://forum.rescript-lang.org/">Forum</a>
34+
<span> · </span>
35+
<a href="CONTRIBUTING.md">Contribute</a>
36+
</h3>
1037

11-
[![npm version](https://badge.fury.io/js/rescript.svg)](https://badge.fury.io/js/rescript) ![Build Status](https://circleci.com/gh/rescript-lang/rescript-compiler.svg?style=svg)
38+
ReScript is a robustly typed language that compiles to efficient and human-readable JavaScript. It comes with a lightning fast compiler toolchain that scales to any codebase size.
1239

13-
## Installation
40+
- **Fast and Simple.** ReScript cares about a consistent and fast feedback loop for any codebase size. Refactor code, pull complex changes, or switch to feature branches as you please. No sluggish CI builds, stale caches, wrong type hints, or memory hungry language servers that slow you down.
41+
- **A Robust Type System.** Every ReScript app is fully typed and provides reliable type information for any given value in your program. We prioritize simpler types over complex types for the sake of clarity and easy debugability. No `any`, no magic types, no surprise `undefined`.
42+
- **Seamless Integration.** Use any library from JavaScript, export ReScript libraries to JavaScript, automatically generate TypeScript types. It's like you've never left the good parts of JavaScript at all.
43+
- **Tooling that just works out of the box.** A builtin pretty printer, memory friendly [VSCode](https://github.com/rescript-lang/rescript-vscode) & [Vim](https://github.com/rescript-lang/vim-rescript) plugins, a stable type system and compiler that doesn't require lots of extra configuration. ReScript brings all the tools you need to build reliable JavaScript, Node and ReactJS applications.
44+
- **Easy to adopt — without any lock-in.** ReScript was made with gradual adoption in mind. If you ever want to go back to plain JavaScript, just remove all source files and keep its clean JavaScript output. Tell your coworkers that your project will keep functioning with or without ReScript!
1445

15-
```sh
16-
npm install --save-dev rescript
17-
```
46+
ReScript is used by many companies to ship and maintain mission-critical products and is maintained by the [ReScript community](https://rescript-lang.org/community).
1847

19-
## Contribution
48+
## Contents
2049

21-
See [CONTRIBUTING.md](CONTRIBUTING.md).
50+
- [Getting Started](#-getting-started)
51+
- [Documentation](#-documentation)
52+
- [Upgrading](#-upgrading)
53+
- [How to Contribute](#-how-to-contribute)
54+
- [License](#-license)
55+
- [Acknowledgments](#-Acknowledgments)
2256

23-
## Acknowledgments
57+
## 🎉 Getting Started
2458

25-
- Thanks to the [OCaml](https://ocaml.org) team, obviously, without such a beautiful yet practical language, this project would not exist. The original type system was inherited from [it](jscomp/ml) with lots of modifications to fit with JS ecosystem better.
26-
- Thanks to [ninja-build](https://ninja-build.org), ReScript also comes with a blazing fast build tool on top of it, `ninja` is a truly [well engineered](http://aosabook.org/en/posa/ninja.html) scalable build tool
27-
- Thanks to [Bloomberg](https://www.techatbloomberg.com) and [Facebook](https://github.com/facebook/). This project began at Bloomberg and was published in 2016; without the support of Bloomberg, it would not have happened. This project's funded by Facebook since July 2017
59+
Follow the [Installation Guide](https://rescript-lang.org/docs/manual/latest/installation) to set up a new ReScript project or integrate ReScript into your existing JavaScript project.
2860

29-
## History
61+
For more information on building React apps with ReScript, see the [rescript-react documentation](https://rescript-lang.org/docs/react/latest/installation).
3062

31-
This project was originally created by [Hongbo Zhang](https://github.com/bobzhang) in 2015 and
32-
still actively maintained by Hongbo Zhang hosted at
33-
[here](https://github.com/rescript-lang/rescript-compiler)
63+
For React Native apps, see the [rescript-react-native website](https://rescript-react-native.github.io/).
3464

35-
It was named BuckleScript and rebranded into [ReScript](https://rescript-lang.org/) in 2020.
36-
The major contributions from contributors include super_errors from
37-
[Cheng](https://github.com/chenglou) and [Cristiano](https://github.com/cristianoc), react_jsx_ppx from [Ricky](https://github.com/rickyvetter).
38-
Cristiano also contributed to several important patches in the upstream native compiler,
39-
in particular, the pattern match compilation.
65+
## 📖 Documentation
4066

41-
More details are available [here](https://github.com/rescript-lang/rescript-compiler/graphs/contributors).
67+
The full documentation for the ReScript language can be found on our [website](https://rescript-lang.org/).
4268

43-
## Licensing
69+
The source for the ReScript documentation and website is hosted in a [separate repo](https://github.com/rescript-association/rescript-lang.org).
4470

45-
See [COPYING](./COPYING) and [COPYING.LESSER](./COPYING.LESSER)
71+
## 🚀 Upgrading
72+
73+
See the [Upgrading Guide](https://rescript-lang.org/docs/manual/latest/installation) for instructions on upgrading to newer ReScript versions.
74+
75+
## 👏 How to Contribute
76+
77+
### [Contributing Guide](CONTRIBUTING.md)
78+
79+
Read our [Contributing Guide](CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to ReScript.
80+
81+
### [Code of Conduct][code]
82+
83+
The ReScript community has adopted a Code of Conduct that we expect project participants to adhere to.
84+
Please read the [full text][code] so that you can understand what actions will and will not be tolerated.
85+
86+
[code]: https://rescript-lang.org/community/code-of-conduct
87+
88+
### [Roadmap][roadmap]
89+
90+
You can learn more about our vision for ReScript in the [Roadmap][roadmap].
91+
92+
[roadmap]: https://rescript-lang.org/community/roadmap
93+
94+
### [Discussions][discussions]
95+
96+
For discussions on ongoing development, see the [Development](https://forum.rescript-lang.org/c/development/8) section of the ReScript forum.
97+
98+
[discussions]: https://rescript-lang.org/community/roadmap
99+
100+
## 📄 License
101+
102+
ReScript is licensed under LGPL version 3, with relaxed rules about creating and distributing combined work. See the [LICENSE](LICENSE) file for details.
46103

47104
`vendor/ocaml.tar.gz` contains the official [OCaml](https://ocaml.org) compiler (version 4.14.0).
48105
Refer to its copyright and license notices for information about its licensing.
49106

50-
`vendor/ninja.tar.gz` contains the vendored [ninja](https://github.com/ninja-build/ninja).
107+
The `ninja` submodule contains the vendored [ninja](https://github.com/ninja-build/ninja) build system.
51108
Refer to its copyright and license notices for information about its licensing.
52109

53-
Note that OSS is for sharing of knowledge, but the authorship should be respected. Copyright headers in each file, Acknowledgements and History section in this file should be kept **intact**.
110+
## 🏅 Acknowledgments
111+
112+
ReScript was originally created by [Hongbo Zhang](https://github.com/bobzhang) in 2015.
54113

55-
See [Credits](./CREDITS.md) for more details.
114+
See [CREDITS.md](CREDITS.md) for further acknowledgements and project history.

0 commit comments

Comments
 (0)