more documentation and new paver tasks for setting up the repo

Author: bnmnetp

README.md

@@ -33,12 +33,38 @@ Once paver is installed you will also need to install sphinxcontrib-paverutils,
 
     # pip install sphinxcontrib-paverutils
 
-Publishing your own materials with Runestone
---------------------------------------------
+Quick Start
+-----------
 
-1. Clone the RunestoneTools repository to your development machine
-2. Create a repository (if you don't already have one where you would like to host the finished product)
-3. paver build
+This guide will get you started with creating your own course materials using the Runestone tools.
+
+1. Clone the RunestoneTools repository to your development machine  ``git clone https://github.com/RunestoneInteractive/RunestoneTools.git``
+
+2. Type the command ``paver build``
+
+You will now have a build folder with a file index.html in it, along with some default content.  The contents of the build folder are suitable for hosting anywhere that you can serve static web content from!  For a small class you could even serve the content using the builtin Python webserver.
+
+::
+
+    $ cd build
+    $ python3 -m http.server
+
+Now from your browser you can open up http://localhost:8000/index.html
+
+Running your own web server isn't always the easiest way to go.  So I have provided a couple of commands to make it easy for you to host your materials using githubs Pages feature.
+
+
+2. Create a repository (if you don't already have one where you would like to host the finished product)  Copy the github URL to your clipboard.
+2. Type the command ``paver setup_github_pages``  You will be prompted to paste in the URL to your repository.
+2. Type the command ``paver deploy``
+2. Now you can access your pages from github at http://username.github.io/repo  where username is your github username, and repo is the repository you created to host your deployed pages.  Note that the deployed pages will be on the branch ``gh-pages``
+
+Details
+~~~~~~~
+
+If you want to know the details of what goes on in the paver commands above here is what is happening:
+
+3. paver build  -- creates build directory and html files
 4. cd build
 5. git init
 5. git remote add origin [email protected]:bnmnetp/deploytest.git

pavement.py

@@ -63,14 +63,17 @@ def build(options):
 
 @task
 def setup_github_pages(options):
-    repo = input("paste your repo URL here: ")
+    if sys.version > '3':
+        repo = input("paste your repo URL here: ")
+    else:
+        repo = raw_input("paste your repo URL here: ")
     os.chdir(options.build.builddir)
     sh("git init")
     sh("git remote add origin %s " % repo)
-    sh("checkout -b gh-pages")
+    sh("git checkout -b gh-pages")
     sh("touch .nojekyll")
     sh("git add .nojekyll")
-    sh("git commit -m 'Create repo and branch'")
+    sh("git commit -m 'Create repo and gh-pages branch'")
     sh("git push --set-upstream origin gh-pages")
     sh("git push origin gh-pages")