Merge pull request #26 from 18F/readme-update

update installation instructions
18F · Jan 1, 2016 · d30fba4 · d30fba4
2 parents 608d3c5 + 2f6e294
commit d30fba4
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.5.1
diff --git a/README.md b/README.md
@@ -10,12 +10,22 @@ Separation of API into a read and a write portion.
 
 # Installation
 
-The OSBU Forecast tool is a simple django application. To install, make sure python3 and [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/index.html) (or other preferred virtualenv framework). Then, installation is as easy as:
+The OSBU Forecast tool is a simple Django application. First, make sure that Python 3 is installed and that you have a version of `virtualenv`:
 
 ```
-git clone https://github.com/18F/osbu-forecast-api.git && osbu-forecast-api   # Clone the repository
-workon && mkvirtualenv forecast
-cd forecast-admin/forecast && pip install -r requirements
+python3 --version
+virtualenv --version
+```
+
+If you receive errors, install [Python 3](https://docs.python.org/3.5/using/index.html) and/or [virtualenv](https://virtualenv.readthedocs.org/en/latest/installation.html).
+
+Then, installation is as easy as:
+
+```
+git clone https://github.com/18F/forecast.git && cd forecast   # Clone the repository
+virtualenv .env   # Create a virtualenv
+source .env/bin/activate   # Activate virtualenv
+cd forecast-admin/forecast && pip install -r requirements.txt   # Install dependencies
 ./manage migrate
 ./manage runserver
 ```