From 9c2756b76b103ef6ee7c5ae141eea1bdc4014920 Mon Sep 17 00:00:00 2001 From: Calen Pennington Date: Wed, 8 May 2013 13:26:47 -0400 Subject: [PATCH] Fix up documentation --- README.md | 13 +++++++++---- doc/development.md | 2 +- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ec17d7c9a4..90b82ff07a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Installation The installation process is a bit messy at the moment. Here's a high-level overview of what you should do to get started. -**TLDR:** There is a `create-dev-env.sh` script that will attempt to set all +**TLDR:** There is a `scripts/create-dev-env.sh` script that will attempt to set all of this up for you. If you're in a hurry, run that script. Otherwise, I suggest that you understand what the script is doing, and why, by reading this document. @@ -77,11 +77,16 @@ environment), and Node has a library installer called Once you've got your languages and virtual environments set up, install the libraries like so: - $ pip install -r pre-requirements.txt - $ pip install -r requirements.txt + $ pip install -r requirements/base.txt + $ pip install -r requirements/post.txt $ bundle install $ npm install +You can also use [`rake`](http://rake.rubyforge.org/) to get all of the prerequisites (or to update) +them if they've changed + + $ rake install_prereqs + Other Dependencies ------------------ You'll also need to install [MongoDB](http://www.mongodb.org/), since our @@ -137,7 +142,7 @@ Studio, visit `127.0.0.1:8001` in your web browser; to view the LMS, visit There's also an older version of the LMS that saves its information in XML files in the `data` directory, instead of in Mongo. To run this older version, run: -$ rake lms + $ rake lms Further Documentation ===================== diff --git a/doc/development.md b/doc/development.md index a6a1de4ef7..c99e99f906 100644 --- a/doc/development.md +++ b/doc/development.md @@ -36,7 +36,7 @@ Check out the course data directories that you want to work with into the To create your development environment, run the shell script in the root of the repo: - create-dev-env.sh + scripts/create-dev-env.sh ## Starting development servers