reason README

The project's README from github.com/reasonml/reason. As one markdown file: README.md.

logo

Reason

Simple, fast & type safe code that leverages the JavaScript & OCaml ecosystems.

Build Status CircleCI Chat

Latest Releases:

native esy package on npm

User Documentation

The Reason user docs live online at https://reasonml.github.io. The repo for those Reason docs lives at github.com/reasonml/reasonml.github.io

Docs links for new users:

Contributing:

npm install -g esy@next
git clone https://github.com/reasonml/reason.git
cd reason
esy
esy test # Run the tests

Contributor Documentation:

The docs/ directory in this repo contains documentation for contributors to Reason itself (this repo).

License

See Reason license in LICENSE.txt.

Works that are forked from other projects are under their original licenses.

Credit

The general structure of refmt repo was copied from whitequark's m17n project, including parts of the README that instruct how to use this with the OPAM toolchain. Thank you OCaml!

reason (reasonml/reason)

Searching Database…

10.3K ·GitHub
What is this?Reason is a programming language for writing simple, fast, type-safe code while leveraging both the JavaScript and OCaml ecosystems.
Is this a language I write in, or a library I add to my project?It is a full programming language, not a library: this repo contains the language itself and its toolchain, and the codebase is written in OCaml.
How do I get started with it?Reason's user docs, including the Getting Started guide, live online at reasonml.github.io; the repo's own README is aimed mostly at contributors.
Do I need OCaml tools like OPAM installed?For building or hacking on Reason itself, yes — the setup instructions use the OPAM toolchain, and CI also exercises esy and nix builds.
Where does Reason code run — browser, server, native?Both worlds: it leverages the JavaScript ecosystem (the web) as well as the OCaml ecosystem (native), so Reason code is not tied to a single runtime.
Is there anything unusual about the license?Reason is MIT-licensed, but anything forked from other projects keeps its original license — check LICENSE.txt before reusing code.
What is refmt?Reason's source formatter. Its repo structure was copied from whitequark's m17n project, including the parts of the README explaining use with the OPAM toolchain.
How mature is the Reason project?It has been on GitHub since November 2015, has around 10,300 stars, is not archived, and has CI workflows building it via esy, nix and opam.
What are similar projects?morloc, crystal, scala, TypeScript, tsrx, milewski-ctfp-pdf, elixir, gleam
Creator
reasonml
Size
25.1 MB
Stars
10.3K
Age
10y
Commits · 90 Days