Merge pull request #103 from ImperialCollegeLondon/docs-review

Update README.md

README.md

@@ -4,13 +4,11 @@
 
 The `docker-compose.setup.ove.yml` file is used as a template to generate the `docker-compose.yml` file. The `docker-compose.yml` file is used to start the services.
 
-1. Using a python3 environment with the `pyyaml` library added, run `python configure.py develop` to create the `docker-compose.yml` file. This also generates the `config/credentials.json` file. The script should automatically detect the IP address of the host machine and use it to configure the services.
+1. Using a python3 environment with the `pyyaml` library added, run `python configure.py develop` to create the `docker-compose.yml` file. The script should automatically detect the IP address of the host machine and use it to configure the services.
 2. Run `docker-compose up -d` to start the OVE services.
-3. There is a convenience script, `run.sh` which combines the above two steps for running in develop mode.
-4. The Dash app should be available at http://localhost:8050/. There are four pages displaying an animated plot at `http://localhost:8050/plot1`, `http://localhost:8050/plot2` etc. <!-- markdownlint-disable-line MD034 -->
-5. The OVE landing page should be available at http://localhost:8080. <!-- markdownlint-disable-line MD034 -->
-6. Go to `http://localhost:8080/ui/launcher` to launch a new OVE application. Select HTML from the dropdown list of app options. The URL should be `http://localhost:8050/plot1`, `http://localhost:8050/plot2` etc. depending on which page you want to display, then click launch at the bottom of the page.
-7. Click "Preview" at the bottom of the same page after launching, or navigate manually to e.g. http://192.168.1.249:8080/ui/preview?oveSpace=SpaceOne to preview each space in your browser. <!-- markdownlint-disable-line MD034 -->
+3. There is a convenience script, `run_develop.sh` which combines the above two steps for running in develop mode.
+4. The Dash app should be available at http://localhost:8050/. <!-- markdownlint-disable-line MD034 -->
+5. The OVE landing page should be available at http://localhost:8080. After a minute or two there should be all the sections defined and set up. <!-- markdownlint-disable-line MD034 -->
 
 N.B. The `configure.py` setup process is required because the actual IP address of the host machine is needed to configure the services. `localhost` or `127.0.0.1` cannot be used (at least OVE doesn't work).
 
@@ -25,9 +23,10 @@ This service is mostly automated with a few steps required to be run outside of
 - `run.sh`
 - `config/`
 - `logs/` - this can be empty
+- `data/` - for the pre-set data (this data needs to be added manually)
 - A `.env` file to define `MY_SECRET` for the OpenVidu login
 
-To run the production version should be as simple as running `bash run.sh` with the above files alongside any override for watchtower etc.
+To run the production version should be as simple as running `bash run.sh` with the above files alongside a `docker-compose.override.yml` for watchtower etc.
 
 Utimately, we will want to automate this setup as much as possible so the environment (local testing vs. deployment) is autodetected. For now, the configuration files differ from those generated in the above setup in the following ways:
 
@@ -42,6 +41,8 @@ There is also a requirements to have the OpenVidu server running - see [Deployin
 
 ## Current steps for Running a WebRTC app and sharing an application window
 
+(Start from step 3 if the vis system is already up and running)
+
 1. Make sure nothing's running
 2. Run `bash run_develop.sh` for vis system to run config script and `docker-compose.yml`
    - For production, use `run.sh`