Garmelon/cove
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Move "Using cove" section to the top

Browse source 
It is fairly important and easily missed if it is placed after the long
"Manual install" section. If I ever add easier ways to install cove
(like providing prebuilt binaries or packaging it on some package
managers), I might change this order again and refer to the "Using cove"
section in the top paragraph instead.
This commit is contained in:
Joscha 2022-09-01 21:09:22 +02:00
parent 19febc188e
commit 067389efa2
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -7,6 +7,17 @@ real-time chat platform.
It runs on Linux, Windows and macOS.
## Using cove
To start cove, simply run `cove` in your terminal. For more info about the
available subcommands such as exporting room logs or resetting cookies, run
`cove --help`.
If you delete rooms, cove's vault (the database it stores messages and other
things in) won't automatically shrink. If it takes up too much space, try
running `cove gc` and waiting for it to finish. This isn't done automatically
because it can take quite a while.
## Manual installation
This section contains instructions on how to install cove by compiling it yourself.
@ -55,14 +66,3 @@ in the full version you want to install:
```bash
$ cargo install --force --git https://github.com/Garmelon/cove --tag v0.1.0
```
### Using cove
To start cove, simply run `cove` in your terminal. For more info about the
available subcommands such as exporting room logs or resetting cookies, run
`cove --help`.
If you delete rooms, cove's vault (the database it stores messages and other
things in) won't automatically shrink. If it takes up too much space, try
running `cove gc` and waiting for it to finish. This isn't done automatically
because it can take quite a while.