Skip to content
Snippets Groups Projects
Commit 94eac0c1 authored by Josh Borrow's avatar Josh Borrow
Browse files

Updated to reflect that we are no longer using nikola

parent 55b24567
No related branches found
No related tags found
No related merge requests found
......@@ -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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment