diff --git a/README.md b/README.md index 055f3af..6c4804b 100644 --- a/README.md +++ b/README.md @@ -3,31 +3,9 @@ Getting Started =============== -## Install Elm Tools - 1. Install [Node.js](http://nodejs.org) 7.0.0 or higher -2. Add a plugin for your editor of choice: [Atom](https://atom.io/packages/language-elm), [Sublime Text](https://packagecontrol.io/packages/Elm%20Language%20Support), [VS Code](https://github.com/sbrink/vscode-elm), [Light Table](https://github.com/rundis/elm-light), [Vim](https://github.com/lambdatoast/elm.vim), [Emacs](https://github.com/jcollard/elm-mode), [Brackets](https://github.com/lepinay/elm-brackets) - -3. Not required, but **highly** recommended: enable "[`elm-format`](https://github.com/avh4/elm-format) on save" in your editor. - -4. Run the following command to install all the other Elm tools: - -> **Note:** Make sure not to run this command with `sudo`! If it gives you an `EACCESS` error, apply [**this fix**](https://docs.npmjs.com/getting-started/fixing-npm-permissions#option-two-change-npms-default-directory) and then re-run the command (still without `sudo`). - -```shell -npm install -g elm@0.19.0 elm-test@0.19.0 elm-live@2.7.5 elm-format@0.7.0-rc -``` - -You can confirm this worked by running: - -```shell -elm --version -``` - -It should print `0.19.0` if everything worked! - -## Clone this repository +2. Clone this repository Run this at the terminal: @@ -36,9 +14,7 @@ git clone https://github.com/rtfeldman/elm-0.19-workshop.git cd elm-workshop ``` -> **Note:** Tab characters are syntax errors in Elm code, so if your editor uses them for indentation, definitely switch it to spaces for this workshop! - -## Start the server +3. Start the server We'll be running a local server for our Elm UI to use. Let's get it set up. @@ -63,7 +39,7 @@ In the new termnal, `cd` into the `elm-workshop/server/` directory again. Then run this to build the Elm code for the first time: ```shell -elm-live src/Main.elm --output=../server/public/elm.js --dir=../server/public --pushstate +elm make src/Main.elm --output=../server/public/elm.js --dir=../server/public --pushstate ``` > It should say "Server running at" and "LiveReload running on" - but we'll ignore both of those, because we'll instead be using the server we already started running in the previous step! @@ -77,7 +53,6 @@ If things aren’t working, the instructor will be happy to help! ## Links -* [Slides](https://docs.google.com/presentation/d/1sNx5k3_fHwJcgm9QEY1LsMH_TyF5SnnOSDKb8HvFsEU/edit?usp=sharing) accompanying this workshop, including speaker notes in case you’d like to [run this workshop yourself](https://github.com/rtfeldman/elm-0.19-workshop/blob/master/TEACHING.md) * [Elm in Action](https://www.manning.com/books/elm-in-action?a_aid=elm_in_action&a_bid=b15edc5c), a book by [Richard Feldman](https://twitter.com/rtfeldman), creator of this workshop * [Official Elm Guide](https://guide.elm-lang.org/) by [Evan Czaplicki](https://twitter.com/czaplic), creator of Elm * [Elm Slack](http://elmlang.herokuapp.com/) - amazingly helpful chat community. People in [the `#beginners` channel](https://elmlang.slack.com/messages/C192T0Q1E/) are happy to answer questions!