diff --git a/.gitignore b/.gitignore index 97ae3db..89a8fc2 100644 --- a/.gitignore +++ b/.gitignore @@ -36,3 +36,6 @@ nosetests.xml # Vagrant /.vagrant/ +contrib/vagrant/.Python +contrib/vagrant/include/ +contrib/vagrant/share/ \ No newline at end of file diff --git a/README.rst b/README.rst index c10693d..a024ebb 100644 --- a/README.rst +++ b/README.rst @@ -9,9 +9,27 @@ Bootstrapping development with Vagrant -------------------------------------- 1. If required, install `Vagrant `_ -2. From the project directory, run ``vagrant up``, and wait for initial bootstrapping. + + The installer will automatically add vagrant to your system path so that + it is available in terminals. If it is not found, please try logging out + and logging back in to your system (this is particularly necessary + sometimes for Windows). + + VirtualBox may also be required. + +2. From the project directory, run ``vagrant up``, and wait for initial + bootstrapping. + + This may take a long time (in the vicinity of an hour) and requires a large + download (in the vicinity of 1GB). + 3. Connect to the VM using ``vagrant ssh``. -4. Change to ``/vagrant``. + +4. Change to ``contrib/vagrant``. + 5. Initialise virtualenv: ``virtualenv .`` -6. Activate: ``./bin/activate`` -7. Install requirements: ``pip install -r ./requirements.txt`` + +6. Activate: ``source contrib/vagrant/bin/activate`` + +7. Change to project directory root. + Install requirements: ``pip install -r ./requirements.txt``