path: root/README.md
diff options
authorPatrick Spek <p.spek@tyil.nl>2020-03-23 00:41:38 +0100
committerPatrick Spek <p.spek@tyil.nl>2020-03-23 00:41:38 +0100
commit309b7c1a9d421c71647e5fadfc686bab7f5068e5 (patch)
tree11398f80495b89d01494e7b3ec37efd20205e2e1 /README.md
parent81529e8a3f065a6adfa06c7ed4c3258a815fded7 (diff)
Extend the README
Diffstat (limited to 'README.md')
1 files changed, 32 insertions, 7 deletions
diff --git a/README.md b/README.md
index 967369c..af42dad 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,11 @@ A user-friendly distribution of the Raku programming language.
## Quickstart
-After downloading and extracting the tarball (or cloning the git repository),
-run `./bin/rstar install`. Follow any on-screen instructions as they appear.
-That is all!
+After downloading and extracting the tarball, run `./bin/rstar install`. Follow
+any on-screen instructions as they appear. That is all!
+*If you cloned the git repository, you will need to run `./bin/rstar fetch`
If you happen to find any bugs, please refer to the **Bugs, Feedback and
Patches** section later on in this document to find out how you can get help.
@@ -27,7 +29,7 @@ required. If any of these are missing, `rstar` will throw an error about it.
#### Exit codes
-- ` 1` - die() was encountered. This is always a bug;
+- ` 1` - `die()` was encountered. This is always a bug;
- ` 2` - The program was invoked incorrectly;
- ` 3` - Some required dependencies are missing.
@@ -97,9 +99,32 @@ list is also a good choice, as are public places such as Reddit.
## Bugs, Feedback and Patches
-Bugs, feedback or patches for this project can be sent to
-`p.spek+rakudo-star@tyil.work`. Alternatively, you can reach out to `tyil` on
-Freenode, DareNET or Matrix.
+Patches for this project can be sent through email to
+To report bugs or provide other feedback, email is an option, but IRC and
+[Matrix](https://matrix.org/) are also available. For IRC, reach out to `tyil`
+on [Freenode](https://freenode.net/) or [DareNET](https://www.darenet.org/).
+For Matrix, sent a message to `tyil:matrix.org`.
+### Bugs
+If you're reporting a bug, please include the full logs of `rstar` with
+`RSTAR_DEBUG=1`, and the output of `rstar sysinfo` in your message.
+### Code Contributions
+Code patches can be sent through email. For help getting started with
+contributing in this fashion, check out https://git-send-email.io/.
+The `rstar` utility is written in `bash`. All additional features should be
+based on this. Using other utilities is accepted, but effort should be made to
+avoid introducing new utilities. Furthermore, all code should be linted against
+[`shellcheck`](https://www.shellcheck.net/) and not produce any warnings.
+Also, try to be generous with comments. Especially when introducing new utility
+functions, a little description of what it does and what problem it is intended
+to solve go a long way.
## License