Update readme
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Cadence Ember 2020-11-26 17:57:05 +13:00
parent 6e209bafd6
commit 70cae25aa7
Signed by: cadence
GPG key ID: BC1C2C61CF521B17

View file

@ -54,7 +54,6 @@ Carbon is currently _technically_ usable as a chat app, but is very
early in development. These important features still need to be early in development. These important features still need to be
implemented: implemented:
- Unreads
- Emojis - Emojis
- Reactions - Reactions
- Encryption - Encryption
@ -63,6 +62,9 @@ implemented:
- Pinned channels - Pinned channels
- Mumble integration - Mumble integration
For more information, see [issue
#10.](https://gitdab.com/cadence/Carbon/issues/10)
## The code ## The code
### Downloading a CI build ### Downloading a CI build
@ -71,12 +73,20 @@ Visit [drone CI](https://drone.badat.dev/cadence/Carbon/branches),
select the branch you want to use, select `b2` on the left, scroll 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. down, and open the URL on the last line to download the build.
### Building yourself ### Building from source yourself
Dependencies:
- git
- node
- npm (bundled with node)
Build:
npm install -D npm install -D
npm run rebuild npm run rebuild
### Hosting ### Hosting a build
Send the files from the `build` folder to a static file server. Apply Send the files from the `build` folder to a static file server. Apply
a long cache-control header to everything served under `/static`, and a long cache-control header to everything served under `/static`, and
@ -91,4 +101,4 @@ Files will be rebuilt as you save them.
Use `python3 -m http.server -d build` to serve the build on Use `python3 -m http.server -d build` to serve the build on
[http://localhost:8000](http://localhost:8000). [http://localhost:8000](http://localhost:8000).
(Avoid `npx http-server`, since this applies too much caching.) (Avoid `npx http-server`, it caches too much stuff.)