Skip to content

Commit 47bb415

Browse files
committed
adds clarifying note on why "Elm(ish)" for #44
1 parent c70ba2b commit 47bb415

File tree

1 file changed

+27
-19
lines changed

1 file changed

+27
-19
lines changed

Diff for: elmish.md

+27-19
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,48 @@
1-
# Elm(_ish_) ?
1+
# `Elm`(_ish_) ?
22

3-
Elm(_ish_) is our **`Elm`** "_inspired_" `JavaScript` (**ES5**)
4-
front-end _micro_-framework.<sup>1</sup>
3+
`Elm`(_ish_) is our **`Elm`**-_inspired_ `JavaScript` (**ES5**)
4+
front-end _micro_-framework.[<sup>1</sup>](#notes)
55

66
## _Why?_
77

8-
The purpose of building Elm(_ish_) is _not_ to "_replace_" Elm
8+
The purpose of building `Elm`(_ish_) is _not_ to "_replace_" Elm
99
or to create _yet another_ front-end JS framework!
1010

11-
The purpose of _separating_ the Elm(ish) functions into a "micro framework" is:
11+
The purpose of _separating_ the `Elm`(_ish_) functions
12+
into a "micro framework" is: <br />
1213
**a)** to ***simplify*** the Todo List application code. <br />
1314
**b)** _demonstrate_ a ***re-useable*** (_fully-tested_)
1415
"**micro-framework**" that allows us to _practice_ the Elm Architecture.<br />
1516
**c)** get into the **mindset** of writing **tests _first_**
16-
and then the _least_ amount of code necessary to pass the test
17+
and **`then`** the _least_ amount of code necessary to pass the test
1718
(_while meeting the acceptance criteria_).
1819

19-
2020
By the end of this exercise you will _understand_
21-
The Elm Architecture (TEA) _much better_ because we will be
22-
analysing, documenting, testing and writing each function required
23-
to build the fully functional "micro framework".
21+
The Elm Architecture (TEA) _much better_
22+
because we will be analysing, documenting, testing
23+
and writing each function required
24+
to build the fully functional "micro framework" ***from scratch***.
25+
2426

2527

26-
<sup>1</sup><small>The reason for calling the micro-framework Elm(ish)
27-
is to emphasize that it is "**inspired by**" **`Elm`**.
28-
But the only thing Elm(ish) shares with Elm is the architecture "pattern".
29-
In all other respects Elm(ish) is a "poor imitation" and should _only_
30-
be used for learning purposes!
31-
To _truly_ appreciate the awesome elegance, simplicity, power
32-
and personal effectiveness of using Elm, there is **no substitute**
33-
for the "real thing".
34-
</small>
3528

29+
## _What?_
3630

3731

3832

3933
You are already _familiar_ with the first few functions
4034
`mount` and `empty`
35+
36+
## Notes
37+
38+
<sup>1</sup><small>The reason for calling the micro-framework `Elm`(_ish_)
39+
is to **emphasize** that it is "**inspired by**" **`Elm`**.
40+
The only things `Elm`(_ish_) shares with `Elm`
41+
are the "MUV" architecture "pattern"
42+
and function naming/argument similarity.
43+
In all other respects `Elm`(_ish_) is a "**poor imitation**"
44+
and should _only_ be used for learning purposes!
45+
To _truly_ appreciate the awesome elegance, simplicity, power
46+
and personal effectiveness of using Elm, there is **no substitute**
47+
for the "real thing".
48+
</small>

0 commit comments

Comments
 (0)