aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoris2016-07-04 19:36:16 +0200
committerJoris2016-07-08 01:10:25 +0200
commit52f9fafc65d81fc8f684dee21f895e85a14c8165 (patch)
tree03ca065804084857fbd9ea852754424fd9b7a9c9 /README.md
parentec08c799d1c1a0713d0ac6140314335950a728d5 (diff)
downloadbudget-52f9fafc65d81fc8f684dee21f895e85a14c8165.tar.gz
budget-52f9fafc65d81fc8f684dee21f895e85a14c8165.tar.bz2
budget-52f9fafc65d81fc8f684dee21f895e85a14c8165.zip
Update getting started section in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 12 insertions, 8 deletions
diff --git a/README.md b/README.md
index a4596ea..5adcea6 100644
--- a/README.md
+++ b/README.md
@@ -2,28 +2,32 @@
Share costs with a group of people.
-## Install nix
+## Getting started
+
+Install nix:
```
curl https://nixos.org/nix/install | sh
```
-## Usage
-
-Open a nix shell:
+Inside the project directory, open a nix shell:
```
nix-shell
```
-Then:
+Inside tmux, add some users with sqlite after the migration is done:
```
-make install
-make build
-make watch
+sqlite3 database
+insert into user(creation, email, name) values (datetime('now'), 'john@mail.com', 'John');
+insert into user(creation, email, name) values (datetime('now'), 'lisa@mail.com', 'Lisa');
```
+## Configuration
+
+[application.conf](application.conf)
+
## TODO
- Income CRUD