Fix up documentation
This commit is contained in:
13
README.md
13
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
|
||||
=====================
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user