From dc121f393d62f2631f80c3d9d23539318646f496 Mon Sep 17 00:00:00 2001 From: Guillaume Slizewicz Date: Wed, 20 Oct 2021 11:03:42 +0200 Subject: [PATCH] detailled the readme file for the process of updating the website --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d4ed499..35f2140 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,34 @@ $ pip install -r requirements.txt # start website locally $ pelican -lr + or + $ make devserver -# Open http://localhost:8000/ +Open http://localhost:8000/ to check the state of the website # Make a change +Create a markdown file or change an existing file and save it. + +Open http://localhost:8000/ to check the new state of the website + # Push changes to git +Check which files you changed +$ git status + +Stage your changes + +$ git add [name of file] + +$ git commit -m " [comment that make it understandable what you just did (commit comments are poetry)]" + +Push them to the repository + +$ git push + # website is saved in output folder, this is the map that goes to the server # copy using rsync $ make rsync_upload