Added structure to readme
This commit is contained in:
parent
aef8f1a572
commit
6cb4833dbd
1 changed files with 13 additions and 1 deletions
14
README.md
14
README.md
|
@ -1,3 +1,10 @@
|
||||||
|
# Run from scratch
|
||||||
|
|
||||||
|
## Database
|
||||||
|
|
||||||
|
Create an empty database. The configured user needs to be able to create and alter stuff.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
Create a configuration file `$HOME/.config/notes.yaml` with the following content:
|
Create a configuration file `$HOME/.config/notes.yaml` with the following content:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -21,4 +28,9 @@ session:
|
||||||
daysvalid: 31
|
daysvalid: 31
|
||||||
```
|
```
|
||||||
|
|
||||||
Create an empty database.
|
## User
|
||||||
|
|
||||||
|
Create a user by running
|
||||||
|
```
|
||||||
|
notes --createuser
|
||||||
|
```
|
||||||
|
|
Loading…
Add table
Reference in a new issue