diff --git a/README.md b/README.md index d4ed499..eeb6526 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,33 @@ # How to install Pelican # clone repository -$ git clone https://gitlab.constantvzw.org/anais_berck/algoliterarypublishing.net.git +""" +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 +""" +python3 -m venv name_environment +""" + +# activate the virtual environment +""" +source name_environment/bin/activate +""" # go to algoliterarypublishing.net folder -$ pip install -r requirements.txt +""" +pip install -r requirements.txt +""" # start website locally -$ pelican -lr +""" +pelican -lr +""" or -$ make devserver +""" +make devserver +""" # Open http://localhost:8000/ @@ -23,5 +37,8 @@ $ make devserver # website is saved in output folder, this is the map that goes to the server # copy using rsync -$ make rsync_upload +""" +make rsync_upload +""" + generates website and puts files in output folder, and transfers them to server using the right urls