diff --git a/README.rst b/README.rst index 8411a90fce7..cf00c9151b2 100644 --- a/README.rst +++ b/README.rst @@ -30,16 +30,46 @@ Pootle. Teams can manage their files, permissions, projects, and translate on-line. Files can be downloaded for offline translation. -Installation +Getting started +--------------- + +The easiest way to get started is by using the docker demo. You will need docker +installed on your system, and to be running as a user with permissions to manage +docker. + +As the docker compose configuration is stored in the pootle directory, you will +need ``git`` installed and ``pip`` for some minimal python dependencies to get +set up. + + +Virtualenv +---------- + +You can optionally use a virtualenv to install the python requirements. This +will make it easier to install and run as a user other than ``root`` + + +Demo install ------------ +First install the requirements + +:: + + git clone https://github.com/translate/pootle + cd pootle + pip install -r requirements/host.txt + +You can now run the demo, using the ``makey`` command runner + :: - pip install --process-dependency-links --pre Pootle + makey demo + +This will take a few moments to pull the required docker images, and +once up you should be able to browse to your pootle server on +http://localhost:8000 -Don't forget to read the `installation guide -`_ -for important details. Copying