Skip to content

Commit 603eba2

Browse files
authored
Merge pull request #24 from reasonml/readme
[Docs] Update readme, direct everything to it
2 parents 028d1f6 + fd8254d commit 603eba2

669 files changed

Lines changed: 18 additions & 51886 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.DS_Store
12
_build/**
23
*~
34
*.cmi
@@ -17,4 +18,4 @@ _build/**
1718
*.install
1819
pkg/META
1920

20-
node_modules
21+
/node_modules/

ORIGINS.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

README.md

Lines changed: 16 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,31 @@
1-
# ReasonProject
1+
# ReasonNativeProject
22

3-
Installation of [`Reason`](http://facebook.github.io/reason/) project and
4-
development environments via `opam`.
3+
Installation of [`Reason`](http://facebook.github.io/reason/) project for native compilation development.
54

6-
> Requirements: `opam`
5+
[More info on the workflow](http://facebook.github.io/reason/nativeWorkflow.html).
76

8-
`ReasonProject` installs the `Reason` toolchain into your global opam directory
9-
using `opam`. `ReasonProject` can therefore be used as a template for new
7+
**Requirements**: [OPAM](https://opam.ocaml.org), the OCaml package manager.
8+
9+
`ReasonNativeProject` installs the `Reason` toolchain into your global opam directory
10+
using `opam`. `ReasonNativeProject` can therefore be used as a template for new
1011
projects, but can also be used to install the toolchain [into the global
11-
environment](#reasonproject-editor-support). `ReasonProject` includes: the
12+
environment](#reasonNativeproject-editor-support). `ReasonNativeProject` includes: the
1213
compiler toolchain, the source formatter, REPL, and IDE support for popular
1314
editors.
1415

15-
> A sandboxed environment models dependencies and builds them into a local
16-
> directory so that it works reliably for anyone. Installing tools into your
17-
> global environment is simply a matter of sourcing the sandboxed environment
18-
> in your `.bashrc`. It's easy to make sandboxed local environments global, and
19-
> very hard to do the reverse, so `ReasonProject` starts with local
20-
> environments.
21-
22-
23-
[![Build Status](https://travis-ci.org/reasonml/ReasonProject.svg?branch=master)](https://travis-ci.org/reasonml/ReasonProject)
16+
[![Build Status](https://travis-ci.org/reasonml/ReasonNativeProject.svg?branch=master)](https://travis-ci.org/reasonml/ReasonNativeProject)
2417

2518
## Install
2619

2720
Install by cloning the repo and running the following commands. These commands
2821
install all dependencies.
2922

3023
```sh
31-
git clone https://github.com/reasonml/ReasonProject.git
32-
cd ReasonProject
33-
opam pin add -y ReasonProject .
24+
git clone https://github.com/reasonml/ReasonNativeProject.git
25+
cd ReasonNativeProject
26+
opam pin add -y ReasonNativeProject .
3427
```
3528

36-
3729
### Run, Change, Rebuild
3830

3931
There are a couple of built-in commands in the `Makefile`.
@@ -49,64 +41,23 @@ then run the commands above to see it effect the output.
4941
The binary output will be in the project root directory -- to run it, type
5042
`./Test.byte`!
5143

52-
53-
### REPL
54-
55-
The `rtop` REPL is built into Reason. The command `rtop` starts the REPL.
56-
57-
58-
## Editor Support
59-
60-
#### Prepare Your Editor
61-
62-
All of the IDE plugins, including integration with error highlighting,
63-
autocomplete, and syntax highlighting are included inside of the built project.
64-
65-
Configure your `EDITOR` to load the `Reason` plugins from your instance of
66-
`ReasonProject`. See the instructions for
67-
[Atom](http://facebook.github.io/reason/tools.html#merlin-atom) and
68-
[Vim](https://github.com/facebook/reason/tree/master/editorSupport/VimReason).
69-
70-
#### IDE support included.
71-
72-
The editor config above mostly exists to load the *actual* editor support, from
73-
the `ReasonProject` build. The only thing we need is to make sure the `PATH`
74-
contains all the important stuff from `ReasonProject`'s build. There are two
75-
approaches: one continues to avoid global variables (as we've done so far), and
76-
the other doesn't.
77-
78-
7944
## Developing Your Project
8045

81-
### Making It Yours
82-
83-
`ReasonProject` is meant to be the starting point of your own project. You'll
46+
`ReasonNativeProject` is meant to be the starting point of your own project. You'll
8447
want to make use of existing libraries in your app, so browse the growing set
8548
of `opam` packages in the [opam repository](http://opam.ocaml.org/packages/).
8649

87-
8850
##### Add Another Dependency
8951

9052
Edit your `opam` file so that you depend on a particular opam package and range
9153
of versions.
9254

93-
94-
### Multiple Projects
95-
96-
You can have multiple clones/forks/builds of `ReasonProject` - one for each of
97-
your projects. When you make changes, you can share the project easily with
98-
anyone else because you are modelling all dependencies via `opam`.
99-
100-
10155
### Creating Libraries
10256

103-
`ReasonProject` sets up your environment for building an application. We
104-
haven't yet mentioned how to then share your work with other people *as* an
105-
`opam` dependency itself. More coming soon.
106-
57+
See the [OPAM instructions](https://opam.ocaml.org/doc/Packaging.html).
10758

10859
## Troubleshooting
10960

11061
In general, if something goes wrong, try upgrading your install of the project
111-
by running `opam upgrade ReasonProject`, or if it failed to install and you
112-
later fixed it, `opam install ReasonProject`.
62+
by running `opam upgrade ReasonNativeProject`, or if it failed to install and you
63+
later fixed it, `opam install ReasonNativeProject`.

UPDATINGDOCS.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/LICENSE

Lines changed: 0 additions & 202 deletions
This file was deleted.

docs/Makefile

Lines changed: 0 additions & 39 deletions
This file was deleted.

0 commit comments

Comments
 (0)