diff --git a/README.md b/README.md index 089840d..ba45380 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,6 @@ Inspired by the multi-centered, tentacular cognition capabilities of the octopus More expanded documentation can be found [here](https://cc.vvvvvvaria.org/wiki/Octomode). -## Local install - -> **WARNING**: It's recommended to use Firefox when working with Octomode -> locally. Chrome or Chromium do not load external etherpads in iframes. - ### Prerequisites * Existing [Etherpad](https://etherpad.org) installation @@ -69,3 +64,17 @@ Open the application at port `5001`, for example: http://localhost:5001 ## Install with URL prefix If you want to install octomode with an URL prefix, like , then you can use the gunicorn WSGI. If you have ran the `make setup` command already, then `gunicorn` is already installed. Configure your application root URL in your `.env` file. You can simply run *octomode* now with the following command to run it with `gunicorn` (and not the built-in Flask dev server): `make action` + +## Which browser to use? + +> **NOTE**: When working collectively, it's recommended to use the same browser +> and if possible also the same version of that browser, to get the same (or at least +> the most similar) PDF. Different operating systems and browsers render CSS rules +> slightly differently, which can result in out-of-sync layouts between across +> a group of people. + +> **WARNING**: It's recommended to use Chrome/Chromium when working with Octomode. +> Firefox renders images in very low quality. + +> **WARNING**: It's recommended to use Firefox when working with Octomode +> locally. Chrome or Chromium do not load external etherpads in iframes. \ No newline at end of file