Merge pull request #194 from qutip/feature/instructions-to-build-locally

Add instructions to build locally and exclude non-site files from the build.

Author: hodgestar

.gitignore

@@ -1,2 +1,3 @@
 .DS_Store/
 _site/
+Gemfile.lock

Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "github-pages", "~> 231", group: :jekyll_plugins
+gem "webrick", "~> 1.8"

README.md

@@ -1,5 +1,24 @@
 Repository for QuTiP web pages
--------------------------------------------
+------------------------------
 
-[https://qutip.org](https://qutip.org)
+This repository contains the Jekyll source documents for building the
+QuTiP and family packages website at [https://qutip.org](https://qutip.org).
+
+Testing locally
+---------------
+
+Complete instructions for testing changes locally can be found in the
+[GitHub documentation](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll).
+
+The short version of the instructions is:
+
+ - Install Ruby and Bundler usings the appropriate tools for your platform.
+ - Run `bundle install` which installs the dependencies listed in the `Gemfile`.
+ - Run `bundle exec jekyll serve` which will build the site and serve it locally.
+
+Deploying changes
+-----------------
+
+Push changes to master triggers the default GitHub pages build action which
+runs Jekyll and deployes the updated website.
 

_config.yml

@@ -0,0 +1,5 @@
+exclude:
+  - "build-scripts/"
+  - "CNAME"
+  - "Gemfile"
+  - "README.md"