~alcinnz/rhapsode

33ca829484e6c241878b6753ad4dfed68f051238 — Adrian Cochrane 1 year, 3 months ago 2e70c6f
Add contribution instructions.
1 files changed, 12 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +12 -0
@@ 1,4 1,5 @@
# Rhapsode
[Repository](https://git.argonaut-constellation.org/~alcinnz/rhapsode) | [Issue Tracker](https://todo.argonaut-constellation.org/~alcinnz/rhapsode) | [Website](https://rhapsode-web.org/)

Web browser targetting voice I/O.



@@ 35,3 36,14 @@ See the wiki for webdev documentation.
3. If you've installed Haskell via e.g. GhcUp, you may need to edit `src/Types.hs` so that `buildDir` is assigned to the absolute path to the Rhapsode repository being built. This is used to know where to find the datafiles.
4. (OPTIONAL) Add `~/.cabal/bin/` to your path if it isn't already.
5. Run Rhapsode with `cabal run https://example.com/`, where "https://example.com/" can/should be replaced any valid URL. Or if you followed step 3, you can replace "cabal run" with "rhapsode".

## Contributing
Please send patches to our [issue tracker](https://todo.argonaut-constellation.org/~alcinnz/rhapsode) by either:

* Attaching the output of `git format-patch`.
* [git send-email](https://git-send-email.io/) to ~alcinnz/rhapsode@todo.argonaut-constellation.org .
* Linking to your fork elsewhere.

Whichever you find most convenient.

If you'd prefer to not make your email address public please contact alcinnz@argonaut-constellation.org !