Merge pull request #24 from smajda/vagrant

readme/dev setup improvements

Author: smajda

README.markdown

@@ -6,13 +6,22 @@ Files for the PythonKC.com website.
 
 ## Development Quickstart Option 1 (vagrant)
 
-First, copy `pythonkc_site/.env.example` to `pythonkc_site/.env` and add
+We're going to use Vagrant and Virtualbox to run pythonkc.com inside a Debian
+VM. We're using the [shell provisioner][] to install Ansible inside our VM and
+then using Ansible to manage the environment from there. (Note: we're *not*
+using the [ansible provisioner][].)
+
+First you need to install [Vagrant][] and [VirtualBox][] and clone [our
+repository][] from github.
+
+Now copy `pythonkc_site/.env.example` to `pythonkc_site/.env` and add
 your own [meetup api key][] and a unique [django secret key][] (`.env` will
 be ignored by git)
 
 Then you have to install some vagrant plugins and build your vagrant box:
 
 ```
+vagrant plugin install vagrant-vbguest
 vagrant plugin install vagrant-hostmanager
 vagrant plugin install vagrant-hostsupdater
 vagrant up
@@ -68,5 +77,11 @@ See: docs/local_development
 
 
 
+[Vagrant]: https://www.vagrantup.com/downloads.html
+[VirtualBox]: https://www.virtualbox.org
+[shell provisioner]: http://docs.vagrantup.com/v2/provisioning/shell.html
+[ansible provisioner]: http://docs.vagrantup.com/v2/provisioning/ansible.html
+[our repository]: https://github.com/pythonkc/pythonkc.com
 [meetup api key]: https://secure.meetup.com/meetup_api/key/
 [django secret key]: http://www.miniwebtool.com/django-secret-key-generator/
+

pythonkc_site/.env.example

@@ -1,3 +1,2 @@
-#!/bin/bash
-export MEETUP_API_KEY='your-meetup-api-key-here'
-export DJANGO_SECRET_KEY='django-secret-key-here'
+MEETUP_API_KEY='your-meetup-api-key-here'
+DJANGO_SECRET_KEY='django-secret-key-here'