README.md

   1 # website
   2
   3 ## Build and run instructions
   4
   5 Install Vagrant and VirtualBox.
   6 After running `vagrant up`, run `vagrant rsync-auto` in the background so that file changes on your host machine can be propagated to the virtual machine.
   7 Use the following git aliases to make it easier to run the custom provision commands:
   8
   9     [alias]
  10         build = !vagrant provision --provision-with build
  11         deploy = !vagrant provision --provision-with deploy && sftp -P 2822 -b getTarBz.sh root@localhost && sftp -b putTarBz.sh root@example.com
  12         run = !vagrant provision --provision-with run
  13         runconf = !vagrant provision --provision-with runconf
  14         test = !vagrant provision --provision-with test
  15
  16 ## Serving files
  17
  18 Create a directory called `static`, and place some markdown files with the `.md` file extension.
  19 One of these files must be called `index.md` as it serves as the main page of the website.
  20
  21 To host images, create a directory in `static` called `img` (i.e. `static/img`).
  22 Place some image files in `img`, and refer to these images in the markdown files using `image/file.png`.
  23
  24 ## Running on a web server
  25
  26 tar -xvjf website.tar.bz
  27 ./website config.json
  28 \1a
  29 bg %1
  30 disown -h %1