1
1
mirror of https://github.com/aelve/guide.git synced 2024-11-24 05:45:11 +03:00
guide/static/help.md

34 lines
1.4 KiB
Markdown
Raw Normal View History

2016-03-04 20:24:32 +03:00
You can edit everything, without registration. (But if you delete everything, I'll roll it back and then make a voodoo doll of you and stick some needles into it).
The most important rule is: **it's collaborative notes, not Wikipedia**. In other words, incomplete entries like this are welcome here:
> **pros:** pretty nice API\
> **cons:** buggy (see an example on my Github, here's the link)
2016-03-15 03:28:57 +03:00
Markdown is supported in most places. 2 noteworthy features: tou can write `[pkg](@hackage)` to get a link to package `pkg` on Hackage, and you can mark snippets of code with `repl` to show that they come from GHCi:
~~~~
~~~ haskell repl
> 2+2
4
~~~
2016-03-15 03:30:33 +03:00
~~~~
2016-03-15 03:28:57 +03:00
2016-03-04 20:24:32 +03:00
Some additional guidelines/observations/etc that probably make sense:
* sort pros/cons by importance
2016-03-05 01:41:22 +03:00
* a library can be in several categories list only pros/cons and examples that are relevant to the category
2016-03-10 21:46:38 +03:00
* don't write about a library if it's worse than all other libraries and doesn't have *anything* that could make it the preferred choice in some situation
2016-03-04 20:24:32 +03:00
* if you don't like something for any reason, edit it
* if you're unsure about something, still write it (just warn others that you're unsure)
* if you have useful information of any kind that doesn't fit, add it to the category notes
2016-03-04 23:20:17 +03:00
2016-03-05 01:46:47 +03:00
Finally, all content here is licensed under [CC BY-SA 3.0][] (it's the same license as on Wikipedia and Stackoverflow).
2016-03-04 23:20:17 +03:00
[CC BY-SA 3.0]: https://creativecommons.org/licenses/by-sa/3.0/