Permalink
Browse files

Make README.md more instructive.

  • Loading branch information...
Evan Czaplicki
Evan Czaplicki committed Oct 3, 2012
1 parent 2ddf216 commit 09346c625aaee5d345e06e73da32f476578ee1a0
Showing with 24 additions and 1 deletion.
  1. +24 −1 README.md
View
@@ -1,4 +1,27 @@
elm-lang.org
============
-The .elm source files used to create [elm-lang.org](http://elm-lang.org/), the home-page of the Elm programming language.
+All source files used to create [elm-lang.org](http://elm-lang.org/), the home-page of the Elm programming language.
+
+### Structure
+
+- `public/` -- all of the .elm files used for the site. This makes up the majority of client-side code.
+- `server/` -- the two Haskell files responsible for serving everything from .elm files to images.
+- `resources/` -- the various resources needed for Elm.
+
+### Set up
+
+Follow these steps to get this all running on your local machine:
+
+##### Unix / Mac
+
+- Fork or [download](https://github.com/evancz/elm-lang.org/downloads) this project.
+- Run `bash compile.sh`. This will compile the server.
+- Run `./Server` to start the server.
+
+##### Windows
+
+- Fork or [download](https://github.com/evancz/elm-lang.org/downloads) this project.
+- Run `compile.bat`. This will compile the server and start it on your machine.
+
+Great! You should be set up with [elm-lang.org](http://elm-lang.org/) running at [localhost:8000/](http://localhost:8000/).

0 comments on commit 09346c6

Please sign in to comment.