From 39fd9f4a725d4c1b7a1c33750716ddad4ee4cc73 Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Wed, 12 Jun 2019 15:02:15 +0200 Subject: [PATCH] Add installation instructions --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc9cba8 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# nooo-hbsc + +Revamped homebrewserver.club website. + +## Build the site locally + +### Preparing your system + +Install the prerequisites: + +```bash +$ apt install -y python3 python-3 python3-venv +``` + +### Installing the Python requirements + +Then create a virtual environment and activate it with: + +```bash +$ python3 -m venv .venv +$ source .venv/bin/activate +``` + +Then install the requirements: + +```bash +$ pip install pelican +```