diff --git a/README.md b/README.md index 0b9ab3b5..88e6ded3 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,36 @@ A React + Redux web application for exploring large scale single cell RNA sequence data. -##### Quickstart: -* `cd client` -* `npm install` -* `npm start` -* `localhost:3000` \ No newline at end of file +### Requirements +- OS: OSX, Windows, Linux +- python 3.6 +- npm +- Google Chrome + + +## Installation + +#### clone project + + git clone https://github.com/chanzuckerberg/cellxgene.git + +#### install client + + cd cellxgene + ./bin/build-client + +#### To use with virtual env for python (optional, but recommended) + + python3 -m venv + source /bin/activate + +#### install server + + python setup.py install + +#### run (with demo data) + + cellxgene + + +*Thanks to Alex Wolf his help with test data*