aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 15 insertions, 16 deletions
diff --git a/README.md b/README.md
index 7190ea6..4faf3cd 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,24 @@
# Personal Page
-Generate a website presenting resume and project from data given by a yaml
-file.
+Live [here](https://guyonvarch.gitlab.io/personalPage).
+
+[![build status](https://gitlab.com/guyonvarch/personalPage/badges/deploy/build.svg)](https://gitlab.com/guyonvarch/personalPage/commits/master)
## Required dependency
- `pdflatex`
-## Getting started
+## Gettings started
-Install nix:
+Install nix and follow the instructions:
-``` bash
+```bash
curl https://nixos.org/nix/install | sh
```
-Then, launch the environment with:
+Then, start the environment with:
-``` bash
+```bash
make start
```
@@ -27,16 +28,14 @@ Later, stop the environment with:
make stop
```
-## Build
+## Deploy on gitlab pages
-``` sh
-make build
+```bash
+./deploy
```
-## Configuration
+## Improvements
-```
-port = 3000
-git = "https://gitlab.com/"
-generateResumes = Daily # Hourly / Daily
-```
+- prettify urls
+- i18n ?
+- blog ?