From b2b9cc5b76dc4d338f6567a60c506bd8958cb98c Mon Sep 17 00:00:00 2001 From: Lanie Hei Date: Thu, 4 Oct 2018 11:26:40 -0500 Subject: [PATCH 1/4] Updates Getting Started Link to Correct Path --- intro/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/intro/README.md b/intro/README.md index 5bd2d0e..9f745bc 100644 --- a/intro/README.md +++ b/intro/README.md @@ -1,7 +1,7 @@ Introduction to Elm Workshop ============================ -If you haven't already, follow the [Getting Started instructions](https://github.com/rtfeldman/elm-0.19-workshop/blob/master/intro/README.md +If you haven't already, follow the [Getting Started instructions](https://github.com/rtfeldman/elm-0.19-workshop#getting-started ) at the root of this repository, then continue here! ## Start the server From 6142e8d685bed8eb8682b11a5c6c1ed1c5a34f61 Mon Sep 17 00:00:00 2001 From: Lanie Hei Date: Thu, 4 Oct 2018 14:22:54 -0500 Subject: [PATCH 2/4] Updates install of elm-format ETARGET error when installing elm-format@rc, and no documentation discussing @rc in elm-format repo. Updated to reflect elm-format [installation instructions](https://github.com/avh4/elm-format#installation-) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b22feb..c9956f8 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Getting Started > **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-test@beta elm-format@rc +npm install -g elm-test@beta elm-format ``` 5. Clone this repository From 3c6e9aeb07726d882b62b0b41abe7458f3c4c735 Mon Sep 17 00:00:00 2001 From: Lanie Hei Date: Thu, 4 Oct 2018 17:45:48 -0500 Subject: [PATCH 3/4] Adds instructions to download elm binary `elm make Main.elm --output elm.js` will not work without first downloading the binary --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c9956f8..a7df4b2 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,13 @@ Getting Started 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) +2. Install the `elm` binary for [Mac](https://github.com/elm/compiler/releases/download/0.19.0/installer-for-mac.pkg), [Windows](https://github.com/elm/compiler/releases/download/0.19.0/installer-for-windows.exe), or [Linux](https://gist.github.com/evancz/442b56717b528f913d1717f2342a295d). -3. Not required, but **highly** recommended: enable "[`elm-format`](https://github.com/avh4/elm-format) on save" in your editor. +3. 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) -4. Run the following command to install all the other Elm tools: +4. Not required, but **highly** recommended: enable "[`elm-format`](https://github.com/avh4/elm-format) on save" in your editor. + +5. 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`). @@ -17,7 +19,7 @@ Getting Started npm install -g elm-test@beta elm-format ``` -5. Clone this repository +6. Clone this repository Run this at the terminal: @@ -26,4 +28,4 @@ git clone https://github.com/rtfeldman/elm-0.19-workshop.git cd elm-0.19-workshop ``` -6. Continue with either the [`intro`](https://github.com/rtfeldman/elm-0.19-workshop/blob/master/intro/README.md) or [`advanced`](https://github.com/rtfeldman/elm-0.19-workshop/blob/master/advanced/README.md) instructions, depending on which workshop you're doing! +7. Continue with either the [`intro`](https://github.com/rtfeldman/elm-0.19-workshop/blob/master/intro/README.md) or [`advanced`](https://github.com/rtfeldman/elm-0.19-workshop/blob/master/advanced/README.md) instructions, depending on which workshop you're doing! From b5697d07651a5d381ab9a8ee8be9df1e0aebd93b Mon Sep 17 00:00:00 2001 From: Lanie Hei Date: Sat, 20 Oct 2018 15:26:55 -0500 Subject: [PATCH 4/4] Removes instructions to add elm-binary/fixes shell command edits as per @rtfeldman's comments --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a7df4b2..1902fa3 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,19 @@ Getting Started 1. Install [Node.js](http://nodejs.org) 7.0.0 or higher -2. Install the `elm` binary for [Mac](https://github.com/elm/compiler/releases/download/0.19.0/installer-for-mac.pkg), [Windows](https://github.com/elm/compiler/releases/download/0.19.0/installer-for-windows.exe), or [Linux](https://gist.github.com/evancz/442b56717b528f913d1717f2342a295d). +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. 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. Not required, but **highly** recommended: enable "[`elm-format`](https://github.com/avh4/elm-format) on save" in your editor. - -5. Run the following command to install all the other Elm tools: +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-test@beta elm-format +npm install -g elm elm-test@elm-0.19.0 elm-format ``` -6. Clone this repository +5. Clone this repository Run this at the terminal: @@ -28,4 +26,4 @@ git clone https://github.com/rtfeldman/elm-0.19-workshop.git cd elm-0.19-workshop ``` -7. Continue with either the [`intro`](https://github.com/rtfeldman/elm-0.19-workshop/blob/master/intro/README.md) or [`advanced`](https://github.com/rtfeldman/elm-0.19-workshop/blob/master/advanced/README.md) instructions, depending on which workshop you're doing! +6. Continue with either the [`intro`](https://github.com/rtfeldman/elm-0.19-workshop/blob/master/intro/README.md) or [`advanced`](https://github.com/rtfeldman/elm-0.19-workshop/blob/master/advanced/README.md) instructions, depending on which workshop you're doing!