diff --git a/README.rst b/README.rst index 8803012cec6d7990e4bee51f3d5860625967962e..83f0da26d3e0b09e9df16f68083aa154006f4bdb 100644 --- a/README.rst +++ b/README.rst @@ -3,9 +3,19 @@ Swift Website This is the website for the SWIFT project. You can build the website by doing the following: -+ Create a virtual environment (`` virtualenv3 env ``) ++ Create a virtual environment (`` virtualenv3 env `` or `` virtualenv env``) and ensure that it is `` python3 ``. + Activate it (`` source env/bin/activate ``) [note to deactivate you want to use the `` deactivate `` keyword in your shell] + Use that virtual environment to install the required packages (`` pip install -r requirements.txt ``) -+ The source files for the website are found in `` site/ ``. Change to this directory. -+ Use `` nikola build `` to build the website. The generated files will be placed in `` output ``. These can now be transferred to your webserver by using `` scp ``. -+ You can start a local webserver to check things worked correctly by using `` nikola serve -b ``. This should open your browser at the same time. ++ Please note that the website also requires that pandoc be installed somewhere on the machine. ++ You can then compile the website by running `` python3 compiler.py `` from this directory. The conpiled files will be placed in `` ./compiled ``, and they can then simply be uploaded to a webserver. It is a fully static website so no need to worry about installing anything! + +Adding to the Website +--------------------- + +TODO: This section. + +### Templates + +### About Page + +### Adding Talks/Publications \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index 67d17bf0ac81c1c8b8e3e61dcccd9bb0885fb46d..489f4d2ab89243b68ca482bfa1b47dfb8445f8f1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,3 @@ -nikola -webassets pyyaml -pygal -pyphen -typogrify +jinja2 +pypandoc