aelve/guide
1
1
Fork 0
mirror of https://github.com/aelve/guide.git synced 2024-11-22 03:12:58 +03:00
Code Issues Projects Releases Wiki Activity

Remove outdated info from README

Browse Source
This commit is contained in:
Artyom Kazak 2019-07-26 19:38:15 +03:00 committed by GitHub
parent 10b50a2451
commit f830c7dc70
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -2,43 +2,6 @@
[![BSD3 license](https://img.shields.io/badge/license-BSD3-blue.svg)](https://github.com/aelve/guide/blob/master/LICENSE)
The beta version is running at [guide.aelve.com](https://guide.aelve.com). The most complete section yet is [the one about lenses](https://guide.aelve.com/haskell/lenses-sth6l9jl).
The production version is running at [guide.aelve.com](https://guide.aelve.com). The new frontend is being developed at [staging.guide.aelve.com](https://staging.guide.aelve.com).
Installation instructions and the explanation of config variables (in `config.json`) are here: [INSTALL.md](INSTALL.md).
## Contributing
If you want to contribute but don't know where to start, grep the source for
`[very-easy]` and `[easy]`, or look at these issues:
* [“your first pull request”][first pr] – really easy things, with detailed “how to fix it” instructions
* [“your second pull request”][second pr] – less easy things, which assume that you already know where stuff happens in the code
* [“not-fleshed-out idea”][ideas] – discussion issues (“should we have users? what better ways are there to present pros and cons?”) which you can help with even if you don't know Haskell
* [“design”][design] – issues about design (which I'm not good at, and so help is wanted)
[first pr]: https://github.com/aelve/guide/issues?q=is%3Aissue+is%3Aopen+label%3A%22your+first+pull+request%22
[second pr]: https://github.com/aelve/guide/issues?q=is%3Aissue+is%3Aopen+label%3A%22your+second+pull+request%22
[ideas]: https://github.com/aelve/guide/issues?q=is%3Aissue+is%3Aopen+label%3A%22not-fleshed-out+idea%22
[design]: https://github.com/aelve/guide/issues?q=is%3Aissue+is%3Aopen+label%3A%22design%22
## Testing
You need `chromedriver` and `selenium-server-standalone` installed (those are the package names on Arch Linux). Then you can do
```
$ java -jar /usr/share/selenium-server/selenium-server-standalone.jar
```
```
$ make back/test
```
## Notes
When you see something like
~~~ haskell
-- See Note [acid-state]
~~~
it means that there's an extensive comment somewhere else in the code, which you can find by grepping for `Note [acid-state]`. This convention was stolen from GHC. If you know some plugin for Emacs that would help with jumping to comments (even if those comments would have to be formatted differently), let me know.