From 7356c0b8be6834208e358e928fd0b56957b98680 Mon Sep 17 00:00:00 2001 From: Richard Feldman Date: Sat, 3 Sep 2016 00:24:44 -0700 Subject: [PATCH] Update READMEs --- part1/README.md | 8 +++----- part10/README.md | 26 +------------------------- part11/README.md | 28 ++-------------------------- part2/README.md | 9 +++------ part3/README.md | 12 +++++------- part4/README.md | 9 +++------ part5/README.md | 6 ++---- part6/README.md | 10 ++++++---- part7/README.md | 7 +------ part8/README.md | 10 ++++++---- part9/README.md | 9 +++------ 11 files changed, 35 insertions(+), 99 deletions(-) diff --git a/part1/README.md b/part1/README.md index 3339156..9d87c99 100644 --- a/part1/README.md +++ b/part1/README.md @@ -1,9 +1,6 @@ Part 1 ====== -The instructor will paste notes from the lesson, including code examples from -Q&A, in [this document](https://docs.google.com/document/d/1ApuSOk9DP0YsQrxhW7-WE8UOEAV4PPnLDDeqUOL2o5k/edit?usp=sharing). - ## Installation ```bash @@ -20,6 +17,7 @@ elm-live Main.elm --open --pushstate --output=elm.js ``` ## References -* [html-to-elm](http://mbylstra.github.io/html-to-elm/) - paste in HTML, get elm-html code + +* [**if-expressions**](http://elm-lang.org/docs/syntax#conditionals) * [elm-html documentation](http://package.elm-lang.org/packages/elm-lang/html/latest) -* [record syntax](http://elm-lang.org/docs/syntax#records) (e.g. `{ foo = 1, bar = 2 }`) +* [html-to-elm](http://mbylstra.github.io/html-to-elm/) - paste in HTML, get elm-html code diff --git a/part10/README.md b/part10/README.md index 97faaca..f6b6bad 100644 --- a/part10/README.md +++ b/part10/README.md @@ -1,9 +1,6 @@ Part 10 ======= -The instructor will paste notes from the lesson, including code examples from -Q&A, in [this document](https://docs.google.com/document/d/1ApuSOk9DP0YsQrxhW7-WE8UOEAV4PPnLDDeqUOL2o5k/edit?usp=sharing). - ## Installation ```bash @@ -19,27 +16,6 @@ elm-package install elm-live Main.elm --open --pushstate --output=elm.js ``` -## Running Tests - -Do either (or both!) of the following: - -#### Running tests on the command line - -```bash -elm-test -``` - -#### Running tests in a browser - -```bash -cd tests -elm-reactor -``` - -Then visit [localhost:8000](http://localhost:8000) and choose `HtmlRunner.elm`. - ## References -* [Using Elm packages](https://github.com/elm-lang/elm-package/blob/master/README.md#basic-usage) -* [elm-test documentation](http://package.elm-lang.org/packages/project-fuzzball/test/latest) -* [`(<|)` documentation](http://package.elm-lang.org/packages/elm-lang/core/4.0.0/Basics#<|) +* [Navigation package documentation](http://package.elm-lang.org/packages/elm-lang/navigation/latest) diff --git a/part11/README.md b/part11/README.md index 97faaca..7cefb76 100644 --- a/part11/README.md +++ b/part11/README.md @@ -1,9 +1,6 @@ -Part 10 +Part 11 ======= -The instructor will paste notes from the lesson, including code examples from -Q&A, in [this document](https://docs.google.com/document/d/1ApuSOk9DP0YsQrxhW7-WE8UOEAV4PPnLDDeqUOL2o5k/edit?usp=sharing). - ## Installation ```bash @@ -19,27 +16,6 @@ elm-package install elm-live Main.elm --open --pushstate --output=elm.js ``` -## Running Tests - -Do either (or both!) of the following: - -#### Running tests on the command line - -```bash -elm-test -``` - -#### Running tests in a browser - -```bash -cd tests -elm-reactor -``` - -Then visit [localhost:8000](http://localhost:8000) and choose `HtmlRunner.elm`. - ## References -* [Using Elm packages](https://github.com/elm-lang/elm-package/blob/master/README.md#basic-usage) -* [elm-test documentation](http://package.elm-lang.org/packages/project-fuzzball/test/latest) -* [`(<|)` documentation](http://package.elm-lang.org/packages/elm-lang/core/4.0.0/Basics#<|) +* [Sortable Table documentation](http://package.elm-lang.org/packages/evancz/elm-sortable-table/latest) diff --git a/part2/README.md b/part2/README.md index 3339156..e0e1472 100644 --- a/part2/README.md +++ b/part2/README.md @@ -1,9 +1,6 @@ -Part 1 +Part 2 ====== -The instructor will paste notes from the lesson, including code examples from -Q&A, in [this document](https://docs.google.com/document/d/1ApuSOk9DP0YsQrxhW7-WE8UOEAV4PPnLDDeqUOL2o5k/edit?usp=sharing). - ## Installation ```bash @@ -20,6 +17,6 @@ elm-live Main.elm --open --pushstate --output=elm.js ``` ## References -* [html-to-elm](http://mbylstra.github.io/html-to-elm/) - paste in HTML, get elm-html code -* [elm-html documentation](http://package.elm-lang.org/packages/elm-lang/html/latest) + * [record syntax](http://elm-lang.org/docs/syntax#records) (e.g. `{ foo = 1, bar = 2 }`) +* [`List.map` documentation](http://package.elm-lang.org/packages/elm-lang/core/3.0.0/List#map) diff --git a/part3/README.md b/part3/README.md index d41aff2..d72ea45 100644 --- a/part3/README.md +++ b/part3/README.md @@ -1,9 +1,6 @@ -Part 2 +Part 3 ====== -The instructor will paste notes from the lesson, including code examples from -Q&A, in [this document](https://docs.google.com/document/d/1ApuSOk9DP0YsQrxhW7-WE8UOEAV4PPnLDDeqUOL2o5k/edit?usp=sharing). - ## Installation ```bash @@ -21,6 +18,7 @@ elm-live Main.elm --open --pushstate --output=elm.js ## References -* [Type Annotation syntax reference](http://elm-lang.org/docs/syntax#type-annotations) -* [`type alias` syntax reference](http://elm-lang.org/docs/syntax#type-aliases) -* [`List.map` documentation](http://package.elm-lang.org/packages/elm-lang/core/3.0.0/List#map) +* [**let-expressions**](http://elm-lang.org/docs/syntax#let-expressions) +* [The Elm Architecture](http://guide.elm-lang.org/architecture/) +* [`onClick` documentation](http://package.elm-lang.org/packages/evancz/elm-html/4.0.2/Html-Events#onClick) +* [record update syntax reference](http://elm-lang.org/docs/syntax#records) (e.g. `{ model | query = "foo" }`) diff --git a/part4/README.md b/part4/README.md index 35fa7a0..92bc541 100644 --- a/part4/README.md +++ b/part4/README.md @@ -1,9 +1,6 @@ -Part 3 +Part 4 ====== -The instructor will paste notes from the lesson, including code examples from -Q&A, in [this document](https://docs.google.com/document/d/1ApuSOk9DP0YsQrxhW7-WE8UOEAV4PPnLDDeqUOL2o5k/edit?usp=sharing). - ## Installation ```bash @@ -21,5 +18,5 @@ elm-live Main.elm --open --pushstate --output=elm.js ## References -* [`onClick` documentation](http://package.elm-lang.org/packages/evancz/elm-html/4.0.2/Html-Events#onClick) -* [record update syntax reference](http://elm-lang.org/docs/syntax#records) (e.g. `{ model | query = "foo" }`) +* [Type Annotation syntax reference](http://elm-lang.org/docs/syntax#type-annotations) +* [`type alias` syntax reference](http://elm-lang.org/docs/syntax#type-aliases) diff --git a/part5/README.md b/part5/README.md index d2d6b6c..411e9af 100644 --- a/part5/README.md +++ b/part5/README.md @@ -1,9 +1,6 @@ -Part 4 +Part 5 ====== -The instructor will paste notes from the lesson, including code examples from -Q&A, in [this document](https://docs.google.com/document/d/1ApuSOk9DP0YsQrxhW7-WE8UOEAV4PPnLDDeqUOL2o5k/edit?usp=sharing). - ## Installation ```bash @@ -21,4 +18,5 @@ elm-live Main.elm --open --pushstate --output=elm.js ## References +* [**case-expressions**](http://elm-lang.org/docs/syntax#conditionals) * [Union Types syntax reference](http://elm-lang.org/docs/syntax#union-types) diff --git a/part6/README.md b/part6/README.md index 38426f3..3bac51e 100644 --- a/part6/README.md +++ b/part6/README.md @@ -1,9 +1,6 @@ -Part 5 +Part 6 ====== -The instructor will paste notes from the lesson, including code examples from -Q&A, in [this document](https://docs.google.com/document/d/1ApuSOk9DP0YsQrxhW7-WE8UOEAV4PPnLDDeqUOL2o5k/edit?usp=sharing). - ## Installation ```bash @@ -18,3 +15,8 @@ elm-package install ```bash elm-live Main.elm --open --pushstate --output=elm.js ``` + +## References + +* [JSON decoding](http://guide.elm-lang.org/interop/json.html) +* [`elm-decode-pipeline` documentation](http://package.elm-lang.org/packages/NoRedInk/elm-decode-pipeline/latest) diff --git a/part7/README.md b/part7/README.md index 3327e8b..9808ec1 100644 --- a/part7/README.md +++ b/part7/README.md @@ -1,9 +1,6 @@ -Part 6 +Part 7 ====== -The instructor will paste notes from the lesson, including code examples from -Q&A, in [this document](https://docs.google.com/document/d/1ApuSOk9DP0YsQrxhW7-WE8UOEAV4PPnLDDeqUOL2o5k/edit?usp=sharing). - ## Installation ```bash @@ -21,8 +18,6 @@ elm-live Main.elm --open --pushstate --output=elm.js ## References -* [**let-expressions**](http://elm-lang.org/docs/syntax#let-expressions) -* [**case-expressions** and **if-expressions**](http://elm-lang.org/docs/syntax#conditionals) * [HTTP Tasks tutorial](http://elm-lang.org/guide/reactivity#http-tasks) * [HTTP Error documentation](http://package.elm-lang.org/packages/evancz/elm-http/3.0.0/Http#Error) * [Modules syntax reference](http://elm-lang.org/docs/syntax#modules) diff --git a/part8/README.md b/part8/README.md index f9e22a4..5717c48 100644 --- a/part8/README.md +++ b/part8/README.md @@ -1,9 +1,6 @@ -Part 7 +Part 8 ====== -The instructor will paste notes from the lesson, including code examples from -Q&A, in [this document](https://docs.google.com/document/d/1ApuSOk9DP0YsQrxhW7-WE8UOEAV4PPnLDDeqUOL2o5k/edit?usp=sharing). - ## Installation ```bash @@ -18,3 +15,8 @@ elm-package install ```bash elm-live Main.elm --open --pushstate --output=elm.js ``` + +## References + +* [JavaScript interop](http://guide.elm-lang.org/interop/javascript.html) +* [github.js](https://github.com/michael/github) diff --git a/part9/README.md b/part9/README.md index 5dbc3c7..2bf7a31 100644 --- a/part9/README.md +++ b/part9/README.md @@ -1,9 +1,6 @@ -Part 8 +Part 9 ====== -The instructor will paste notes from the lesson, including code examples from -Q&A, in [this document](https://docs.google.com/document/d/1ApuSOk9DP0YsQrxhW7-WE8UOEAV4PPnLDDeqUOL2o5k/edit?usp=sharing). - ## Installation ```bash @@ -41,5 +38,5 @@ Then visit [localhost:8000](http://localhost:8000) and choose `HtmlRunner.elm`. ## References * [Using Elm packages](https://github.com/elm-lang/elm-package/blob/master/README.md#basic-usage) -* [elm-test documentation](http://package.elm-lang.org/packages/project-fuzzball/test/latest) -* [`(<|)` documentation](http://package.elm-lang.org/packages/elm-lang/core/4.0.0/Basics#<|) +* [elm-test documentation](http://package.elm-lang.org/packages/elm-community/elm-test/latest) +* [`(<|)` documentation](http://package.elm-lang.org/packages/elm-lang/core/latest/Basics#<|)