1
1
# elm-lang.org: a template for creating websites in Elm
2
2
3
- This project contains all of the source files used to create [ elm-lang.org] ( http://elm-lang.org/ ) ,
4
- the home-page of the Elm programming language.
3
+ This project contains all of the source files used to create
4
+ [ elm-lang.org] ( http://elm-lang.org/ ) , the home-page of the Elm programming
5
+ language.
5
6
6
- The project provides a general structure for creating your own Elm website, mixing Elm, images,
7
- videos, HTML/CSS/JS, and whatever else you need.
7
+ The project provides a general structure for creating your own Elm website,
8
+ mixing Elm, images, videos, HTML/CSS/JS, and whatever else you need.
8
9
9
- This project includes a Haskell server that determines how to serve each kind of file, so you
10
- only need to think about the content.
10
+ This project includes a Haskell server that determines how to serve each kind of
11
+ file, so you only need to think about the content.
11
12
12
13
### Set up
13
14
@@ -16,27 +17,26 @@ First make sure that you have the Elm compiler installed
16
17
17
18
Then follow these steps to get this all running on your local machine:
18
19
19
- ###### Unix / Mac
20
-
21
- - Fork this project.
22
- - Run ` bash compile.sh ` . This will compile the server .
20
+ - Clone this project.
21
+ - Run ` cabal clean && cabal build && cabal install ` . Note the ` clean ` step is
22
+ often necessary if you previously compiled with a different version of the
23
+ server due to stale compiled Elm files .
23
24
- Run ` ./ElmServer ` to start the server.
24
25
25
- ###### Windows
26
-
27
- - Fork this project.
28
- - Run ` compile.bat ` . This will compile the server and start it on your machine.
29
-
30
- Great! You should be set up with [ elm-lang.org] ( http://elm-lang.org/ ) running at [ localhost:8000/] ( http://localhost:8000/ ) .
26
+ Great! You should be set up with [ elm-lang.org] ( http://elm-lang.org/ ) running at
27
+ [ localhost:8000/] ( http://localhost:8000/ ) .
31
28
32
29
### Project Structure
33
30
34
- - ` public/ ` &mdash ; all of the .elm files used for the site. This makes up the majority of client-side code.
35
- You can change/delete the existing files and add entirely new files. The changes, deletions, and additions will
36
- be served automatically.
37
- - ` resources/ ` &mdash ; the various resources needed for Elm. This is where you put all of your non-Elm content,
38
- like images, videos, JavaScript code, etc.
39
- - ` server/ ` &mdash ; the Haskell files responsible for serving everything from .elm files to images. Look here
40
- if you need to change how a particular resource is served or if you want to disable some of the sites
41
- features (such as the online editor).
31
+ - ` public/ ` &mdash ; all of the .elm files used for the site. This makes up the
32
+ majority of client-side code. You can change/delete the existing files and
33
+ add entirely new files. The changes, deletions, and additions will be served
34
+ automatically.
35
+
36
+ - ` resources/ ` &mdash ; the various resources needed for Elm. This is where you
37
+ put all of your non-Elm content, like images, videos, JavaScript code, etc.
42
38
39
+ - ` server/ ` &mdash ; the Haskell files responsible for serving everything from
40
+ .elm files to images. Look here if you need to change how a particular
41
+ resource is served or if you want to disable some of the sites features (such
42
+ as the online editor).
0 commit comments