Update readme - add bug report instructions
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Cadence Ember 2020-10-21 22:53:47 +13:00
parent a56c42311f
commit ff427d0354
Signed by: cadence
GPG key ID: BC1C2C61CF521B17

View file

@ -2,12 +2,31 @@
Carbon is the Matrix client for Discord and Guilded refugees.
Visit the hosted instance on
[https://carbon.chat](https://carbon.chat).
## Report bugs and suggest features
Please briefly check this README and the issues page first to make
sure that the issue/feature is not already known!
- If you already have an account on Gitdab, use the issues page.
- If you don't have an account, and don't wish to create one, you can
send an email to the [mailing list].
If something in the interface isn't working as you think it should,
please provide a screenshot of any messages from the browser devtools
console. If using the mailing list, attachments aren't supported, so
you'll have to upload to some image host and post the link.
[mailing list]: https://lists.sr.ht/~cadence/carbon-discuss
## The dream
Carbon's planned features, compared to Discord and Guilded:
- End to end encryption
- Free of charge per-account custom emojis and custom emoji packs
- Free of charge, per-account, custom emojis and custom emoji packs
- No limit to number of groups you can join at a time
- Uses the open Matrix and Mumble systems
- Much better IRC layout
@ -41,6 +60,7 @@ implemented:
- Formatting
- Emojis
- Reactions
- Encryption
- Groups v2
- Group management
- Pinned channels
@ -48,7 +68,13 @@ implemented:
## The code
### Building
### Downloading a CI build
Visit [drone CI](https://drone.badat.dev/cadence/Carbon/branches),
select the branch you want to use, select `b2` on the left, scroll
down, and open the URL on the last line to download the build.
### Building yourself
npm install -D
npm run rebuild
@ -64,3 +90,8 @@ no cache-control header to everything else.
npm run watch
Files will be rebuilt as you save them.
Use `python3 -m http.server -d build` to serve the build on
[http://localhost:8000](http://localhost:8000).
(Avoid `npx http-server`, since this applies too much caching.)