aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 15 insertions, 10 deletions
diff --git a/README.md b/README.md
index d013260..2787d31 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,35 @@
-[Cooking](https://guyonvarch.gitlab.io/cooking)
-===============================================
+# Cooking
+
+Live [here](https://guyonvarch.gitlab.io/cooking).
[![build status](https://gitlab.com/guyonvarch/cooking/badges/master/build.svg)](https://gitlab.com/guyonvarch/cooking/commits/master)
-Gettings started
-----------------
+## Gettings started
Install nix and follow the instructions:
-```sh
+```bash
curl https://nixos.org/nix/install | sh
```
-Then:
+Then, start the environment with:
-```sh
+```bash
make start
```
Later, stop the environment with:
-```sh
+```bash
make stop
```
-TODO
-----
+## Build
+
+```bash
+./build
+```
+
+## TODO
- transform points into todo items