CC/octomode
12
0
Fork 0
Code Issues 18 Pull Requests Projects Releases Wiki Activity

Turning the browser warning section into a more general "which browser to use" section

Browse Source
This commit is contained in:
mb 2023-11-29 14:19:15 +01:00
parent 9a96c2a01d
commit d9ffdc1645
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -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). 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 ### Prerequisites
* Existing [Etherpad](https://etherpad.org) installation * 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 ## Install with URL prefix
If you want to install octomode with an URL prefix, like <https://mydomainname.ext/octomode/>, 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` If you want to install octomode with an URL prefix, like <https://mydomainname.ext/octomode/>, 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.