mirror of
https://github.com/correl/elm.git
synced 2024-12-18 11:06:17 +00:00
Add docs in support of x-api v3
This commit is contained in:
parent
fbf6f351a8
commit
346f6cdd93
3 changed files with 26 additions and 1 deletions
|
@ -11,7 +11,8 @@
|
|||
|
||||
],
|
||||
"ignored": [
|
||||
"bin"
|
||||
"bin",
|
||||
"docs"
|
||||
],
|
||||
"foregone": [
|
||||
|
||||
|
|
8
docs/INSTALLATION.md
Normal file
8
docs/INSTALLATION.md
Normal file
|
@ -0,0 +1,8 @@
|
|||
Download and install a recent Elm Platform for your OS from [elm-lang.org/install](http://elm-lang.org/install).
|
||||
|
||||
## MacOS
|
||||
|
||||
```bash
|
||||
$ npm install --global elm
|
||||
$ elm-package install -y
|
||||
```
|
16
docs/TESTS.md
Normal file
16
docs/TESTS.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
First, execute the following:
|
||||
```bash
|
||||
$ elm-reactor
|
||||
```
|
||||
Then go to `localhost:8000` in your browser and navigate to your test file.
|
||||
|
||||
## Making Your First Elm Module
|
||||
|
||||
To create a module that can be loaded with `import BobExample exposing (responseFor)`, put this code in `BobExample.elm`:
|
||||
|
||||
```elm
|
||||
module BobExample where
|
||||
|
||||
responseFor : String -> String
|
||||
responseFor statement = undefined
|
||||
```
|
Loading…
Reference in a new issue