Skip to content

Commit fe5dce7

Browse files
bryanjosbryanjos
committed
Update docs
1 parent 5914b3c commit fe5dce7

4 files changed

Lines changed: 11 additions & 82 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,27 +64,26 @@ 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, mostly written in Elixir
67+
* The standard library modules, written in Elixir
6868
* The javascript core
6969

7070
The ElixirScript compiler is in the `lib` folder of the project.
7171
Here is where Elixir code is converted into JavaScript.
7272

73-
The standard library modules are in the `lib/std_lib` folder.
73+
The standard library modules are in the `priv/std_lib` folder.
7474

7575
The JavaScript code is in the `src/javascript`.
76-
This is where features such as pattern matching and the standard library are implemented.
76+
This is where features such as pattern matching and the special forms are implemented.
7777

7878
The ElixirScript tests can be run using `mix test`
7979

80-
The JavaScript tests can be run using `npm test`
80+
The JavaScript tests can be run using `yarn test`
8181

8282
Please make sure all tests pass after making changes. Also make sure to include tests for
8383
the changes you made.
8484

85-
Contributing to the JavaScript code may be the easiest and most rewarding changes.
86-
Don't see a feature, module or function from Elixir in ElixirScript yet? You can implement it
87-
in the JavaScript code.
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.
8887

8988
## Pull requests
9089

@@ -119,7 +118,7 @@ in order to craft an excellent pull request:
119118
# Navigate to the newly cloned directory
120119
cd elixirscript
121120
# Assign the original repo to a remote called "upstream"
122-
git remote add upstream https://github.com/bryanjos/elixirscript
121+
git remote add upstream https://github.com/elixirscript/elixirscript
123122
```
124123

125124
2. If you cloned a while ago, get the latest changes from upstream:
@@ -150,7 +149,7 @@ in order to craft an excellent pull request:
150149

151150
```sh
152151
mix test
153-
npm test
152+
yarn test
154153
```
155154

156155
This is needed to ensure your changes can

‎FAQ.md‎

Lines changed: 1 addition & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -6,77 +6,7 @@
66

77
# Q. How much is implemented?
88

9-
### A. Most of Kernel.SpecialForms as well as some modules in the Standard Library
10-
11-
The compiler to this point has been focused on translating Kernel.SpecialForms and Kernel. Below is a list of what is complete, incomplete, as well as missing
12-
13-
#### Kernel.SpecialForms
14-
15-
* Complete
16-
* `__DIR__`
17-
* `__MODULE__`
18-
* `^var`
19-
* `&expr`
20-
* `for`
21-
* `%{}`
22-
* `{args}`
23-
* `<<args>>`
24-
* `fn [clauses] end`
25-
* `cond(clauses)`
26-
* `__block__`
27-
* `__aliases__`
28-
* `unquote`
29-
* `unquote_splicing`
30-
* `%`
31-
* `left.right`
32-
* `quote`
33-
* `import`
34-
* `case`
35-
* `left = right`
36-
* `require`
37-
* `left :: right`
38-
* `alias`
39-
* `__CALLER__`
40-
* `__ENV__`
41-
* `super(args)`
42-
43-
* Missing
44-
* `receive`
45-
46-
* Caveats
47-
* `quote` - ignores `context` options
48-
* `left = right` does not support full unification yet.
49-
```elixir
50-
a = 1 # works as expected
51-
52-
1 = a # may not work currently, but in some cases it will
53-
```
54-
55-
56-
#### Completed Modules
57-
58-
* Tuple
59-
* List
60-
* Atom
61-
* Range
62-
* Map
63-
* MapSet
64-
65-
#### Incomplete Modules
66-
67-
* Kernel
68-
* Enum
69-
* Agent
70-
* Integer
71-
* Keyword
72-
* Base
73-
* String
74-
* Bitwise
75-
* Set
76-
77-
#### Missing Modules
78-
* Everything else
79-
9+
### A. Check out the [Supported Modules, Functions, and Macros](Supported.md)
8010

8111
## Q. Can I use it today?
8212

‎lib/elixir_script/gen/supported.ex‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ defmodule ElixirScript.Gen.Supported do
2929
module_map = get_module_map()
3030

3131
Enum.each(module_map, fn({elixir_module, elixir_script_module}) ->
32-
IO.puts(file, "## #{inspect elixir_module}")
32+
IO.puts(file, "## #{inspect elixir_module}")
3333
exports = elixir_module.__info__(:functions) ++ elixir_module.__info__(:macros)
3434
elixir_script_exports = if Code.ensure_loaded?(elixir_script_module) do
3535
elixir_script_module.__info__(:functions) ++ elixir_script_module.__info__(:macros)

‎mix.exs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ defmodule ElixirScript.Mixfile do
1515
aliases: aliases(),
1616
test_coverage: [tool: ExCoveralls],
1717
docs: [
18-
extras: ["GettingStarted.md", "FAQ.md"]
18+
extras: ["GettingStarted.md", "FAQ.md", "Supported.md"]
1919
]
2020
]
2121
end

0 commit comments

Comments
 (0)