From 085923b640f88e616cc1e258c2358f4cfa0e4dcb Mon Sep 17 00:00:00 2001 From: manetta Date: Wed, 11 Mar 2020 14:43:13 +0100 Subject: [PATCH] added a note on cloning submodules when you forgot to do it in the initial commit --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 59f6e26..d75c389 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,11 @@ The other one, 'plugins-custom', consists of plugins that we wrote ourself. To clone both the varia.website and pelican-plugins repository, add the --recurse-submodules option in your git clone command: -`git clone https://git.vvvvvvaria.org/varia/varia.website.git --recurse-submodules` +`$ git clone https://git.vvvvvvaria.org/varia/varia.website.git --recurse-submodules` +If you forgot to clone with the submodile argument, you can still do it with the following command: + +`$ git submodule update --init --recursive` ## Install @@ -35,10 +38,14 @@ $ pip3 install -r requirements.txt You can make use of the makefile, for example by running the following command to start a python server: -$ make devserver +`$ make devserver` Visit the website at localhost:8000 +To see what is in the makefile, try: + +`$ make help` + ## Update submodules We are currently using two submodules: @@ -48,11 +55,11 @@ We are currently using two submodules: To update these submodules within your (already) cloned repository, first init the submodule, and then update it: - cd /path/to/submodule +`cd /path/to/submodule` - git submodule init +`git submodule init` - git submodule update +`git submodule update` ## Posting Content