Skip to content

Commit 4080313

Browse files
committed
Update documentation
1 parent f07fac7 commit 4080313

File tree

3 files changed

+4
-55
lines changed

3 files changed

+4
-55
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Good bug reports are extremely helpful - thank you!
1818
Guidelines for bug reports:
1919

2020
1. **Use the GitHub issue search** — [check if the issue has already been
21-
reported](https://github.com/bryanjos/elixirscript/search?type=Issues).
21+
reported](https://github.com/elixirscript/elixirscript/search?type=Issues).
2222

2323
2. **Check if the issue has been fixed** — try to reproduce it using the
2424
`master` branch in the repository.
@@ -64,16 +64,13 @@ found in Elixir in ElixirScript.
6464
ElixirScript is broken up into the following parts:
6565

6666
* The compiler, written in Elixir
67-
* The standard library modules, written in Elixir
68-
* The javascript core
67+
* The JavaScript core
6968

7069
The ElixirScript compiler is in the `lib` folder of the project.
7170
Here is where Elixir code is converted into JavaScript.
7271

73-
The standard library modules are in the `priv/std_lib` folder.
74-
7572
The JavaScript code is in the `src/javascript`.
76-
This is where features such as pattern matching and the special forms are implemented.
73+
This is where the special forms and the Erlang Compatibility Layer are defined
7774

7875
The ElixirScript tests can be run using `mix test`
7976

@@ -82,9 +79,6 @@ The JavaScript tests can be run using `yarn test`
8279
Please make sure all tests pass after making changes. Also make sure to include tests for
8380
the changes you made.
8481

85-
Contributing to the standard library may be the easiest and most rewarding changes.
86-
Don't see a module, function or macro from Elixir in ElixirScript yet? You can help by implementing it.
87-
8882
## Pull requests
8983

9084
Good pull requests - patches, improvements, new features - are a fantastic

FAQ.md

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

README.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The goal is to convert a subset (or full set) of Elixir code to JavaScript, prov
55
Requirements
66
===========
77
* Erlang 20 or greater
8-
* Elixir 1.5 or greater
8+
* Elixir 1.5 or greater (must be compiled with Erlang 20 or greater)
99
* Node (only for development)
1010

1111
Usage
@@ -67,21 +67,3 @@ Contributing
6767
========
6868

6969
Please check the [CONTRIBUTING.md](CONTRIBUTING.md)
70-
71-
72-
### Example projects
73-
* [hello](https://github.com/bryanjos/hello) Shows using Phoenix + Elixirscript with file watching
74-
* [Elixirscript frontend boilerplate](https://github.com/elixirscript/elixirscript-project-boilerplate) A boilerplate project for elixirscript frontends
75-
* [Elixirscript React example](https://github.com/bryanjos/elixirscript_react) An example of using with React
76-
* [Elixirscript AWS Lambda example](https://github.com/bryanjos/elixirscript_lambda)
77-
78-
#### Using with Brunch
79-
There is a plugin for using ElixirScript in your Brunch project
80-
[here](https://www.npmjs.com/package/elixirscript-brunch)
81-
82-
#### Using with Webpack
83-
There is a loader for using ElixirScript in your Webpack project
84-
[here](https://www.npmjs.com/package/elixirscript-loader)
85-
86-
#### 1.0 Roadmap
87-
There is a [1.0.0 Milestone](https://github.com/bryanjos/elixirscript/milestones/1.0.0) defined which includes issues that are needed to be cleared before 1.0 can be reached.

0 commit comments

Comments
 (0)