diff --git a/README.md b/README.md index 903da2b..e4d5e99 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ -# algoliterarypublishing.net +# How to install Pelican +# clone repository +$ git clone https://gitlab.constantvzw.org/anais_berck/algoliterarypublishing.net.git + +# create virtual environment with venv +$ python3 -m venv name_environment +$ source name_environment/bin/activate + +# go to algoliterarypublishing.net folder +$ pip install -r requirements.txt + +# start website locally +$ pelican -lr + +# Open http://localhost:8000/ + +# Make a change + +# Push changes to git + +# website is saved in output folder, this is the map that goes to the server +# copy using scp +$ make publish +generates website and puts files in output folder, and transfers them to server using the right urls \ No newline at end of file