aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ee173d7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+[Jardin](https://guyonvarch.gitlab.io/jardin)
+=============================================
+
+[![build status](https://gitlab.com/guyonvarch/jardin/badges/master/build.svg)](https://gitlab.com/guyonvarch/jardin/commits/master)
+
+Gettings started
+----------------
+
+Install nix and follow the instructions:
+
+```sh
+curl https://nixos.org/nix/install | sh
+```
+
+Then:
+
+```sh
+make start
+```
+
+Later, stop the environment with:
+
+```sh
+make stop
+```