Show resume and projects from a configuration file

1 files changed, 42 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7190ea6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# Personal Page
+
+Generate a website presenting resume and project from data given by a yaml
+file.
+
+## Required dependency
+
+- `pdflatex`
+
+## Getting started
+
+Install nix:
+
+``` bash
+curl https://nixos.org/nix/install | sh
+```
+
+Then, launch the environment with:
+
+``` bash
+make start
+```
+
+Later, stop the environment with:
+
+```bash
+make stop
+```
+
+## Build
+
+``` sh
+make build
+```
+
+## Configuration
+
+```
+port = 3000
+git = "https://gitlab.com/"
+generateResumes = Daily # Hourly / Daily
+```