Skip to content
This repository was archived by the owner on Oct 5, 2024. It is now read-only.

Commit 07382a6

Browse files
harrysarsonJaniczek
authored andcommitted
Document new formatting (#25)
This is needed on the back of #24 and #12
1 parent 1e93bf6 commit 07382a6

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,8 @@ The tooling around this project requires:
109109

110110
* **`make`** for the [Makefile](Makefile)
111111
* **NodeJS 10+** for the [CLI tool](src/index.js)
112-
* **`elm`** and **`elm-test`**
112+
* **`elm`**, **`elm-test`** and **`elm-format`**
113+
113114

114115
or alternatively a good amount of ingenuity to do stuff in a different-than-planned way.
115116

@@ -127,6 +128,14 @@ $ make test
127128
```
128129
Runs `elm-test` on the test suite (gasp!)
129130

131+
## Formatting code
132+
133+
```
134+
$ make format
135+
```
136+
Runs elm-format.
137+
Make sure to format code before submitting a pull request!
138+
130139
## Small TODOs
131140

132141
> This is a brain-dump of some low-level stuff. (High-level stuff should be in the roadmap.) My apologies if it's hard to make sense of this! ~janiczek

0 commit comments

Comments
 (0)