Skip to content
This repository was archived by the owner on Aug 1, 2024. It is now read-only.

Commit 3f0b732

Browse files
author
Clinton Blackburn
committed
Updated README with prerequisites and remaining work
ECOM-6560
1 parent 0b62f92 commit 3f0b732

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ limited at the moment, so it may take a while to respond to issues.
99

1010
You should run any Make targets described below on your local machine, _not_ from within a VM.
1111

12+
## Prerequisites
13+
14+
This project was developed and tested using **Docker 1.13+**. If you are using OS X, please use [Docker for Mac](https://docs.docker.com/docker-for-mac/).
15+
Previous Mac-based tools (e.g. boot2docker) are not supported.
16+
17+
[Docker for Windows](https://docs.docker.com/docker-for-windows/) may work but has not been tested and is _not supported_.
18+
19+
1220
## Getting Started
1321

1422
All of the services can be run by following the steps below. Note that since we are running many containers, you should
@@ -46,3 +54,11 @@ For example to access the Catalog/Course Discovery Service, you can run:
4654
```
4755
$ make devstack.open.discovery
4856
```
57+
58+
## Remaining Work
59+
60+
There is still work to be done before this is ready for full release to the Open edX community. Here are the major items:
61+
62+
1. Align with [OEP-5](http://open-edx-proposals.readthedocs.io/en/latest/oep-0005.html)
63+
2. Finish provisioning all services
64+
3. Load demo data

0 commit comments

Comments
 (0)