Skip to content

Commit

Permalink
Update readme (#201)
Browse files Browse the repository at this point in the history
Heavily update the README following some very good guidelines on writing 
technical documentation: https://www.divio.com/blog/documentation/

Now documented things are split between parts with different needs/tone
instead of being in a single giant tutorial:
  - "Tutorial"
  - "Howto"
  - "Explanation"
  - "Troubleshooting"
  • Loading branch information
f-f authored May 16, 2019
1 parent 10da27f commit c5ea3d0
Show file tree
Hide file tree
Showing 2 changed files with 521 additions and 265 deletions.
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@ If it's your first time contributing then it's probably best to pick the ones ma
with "good first issue".

The easiest way you can help is by contributing documentation (look for issues with
the label "document me").
the label "document me").

Do not worry if it's just about copypasting some instructions from an issue to the README,
everything is welcome!

If you wish to contribute documentation, [this is a suggested read](https://www.divio.com/blog/documentation/)

## Developing `spago`

Expand All @@ -46,6 +48,11 @@ To install the version you're developing system-wide, do
$ stack install
```

If you edit any title in the readme, run `doctoc` to update the Table of Contents:

```bash
doctoc --notitle README.md
```

## Running tests

Expand Down
Loading

0 comments on commit c5ea3d0

Please sign in to comment.