Update README.md
This commit is contained in:
1 parent
92ddce0661
commit
d3cdbb9821
1 file changed
+14
-2
@@ -13,7 +13,7 @@ A plugin system for customizing and extending [CrossPoint Reader](https://github
|
|||||||
|
|
||||||
### Dark Mode
|
### Dark Mode
|
||||||
|
|
||||||
Adds a **Dark Mode** option to the Plugins settings tab. When enabled, the screen is inverted after each page render, producing white-on-black text across all reader formats (EPUB, TXT, and XTC).
|
Adds a **Dark Mode** option to the Plugins settings tab and the web interface Settings page. When enabled, the screen is inverted after each page render, producing white-on-black text across all reader formats (EPUB, TXT, and XTC).
|
||||||
|
|
||||||
| State | Effect |
|
| State | Effect |
|
||||||
|-------|--------|
|
|-------|--------|
|
||||||
@@ -22,7 +22,7 @@ Adds a **Dark Mode** option to the Plugins settings tab. When enabled, the scree
|
|||||||
|
|
||||||
### Smaller Fonts
|
### Smaller Fonts
|
||||||
|
|
||||||
Adds a **Smaller Fonts** option to the Plugins settings tab. When enabled, your chosen reader font is transparently substituted with a smaller variant — no need to change your font preference.
|
Adds a **Smaller Fonts** option to the Plugins settings tab and the web interface Settings page. When enabled, your chosen reader font is transparently substituted with a smaller variant — no need to change your font preference.
|
||||||
|
|
||||||
| Mode | Effect |
|
| Mode | Effect |
|
||||||
|------|--------|
|
|------|--------|
|
||||||
@@ -53,6 +53,12 @@ From the root of this repository, run:
|
|||||||
python3 install.py
|
python3 install.py
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To auto-accept all plugin prompts, pass `--yes` (or `-y`):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 install.py --yes
|
||||||
|
```
|
||||||
|
|
||||||
By default this uses the `default` build environment. To use a different environment pass `-e`:
|
By default this uses the `default` build environment. To use a different environment pass `-e`:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -60,6 +66,12 @@ python3 install.py -e slim
|
|||||||
python3 install.py -e gh_release
|
python3 install.py -e gh_release
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Flags can be combined:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 install.py --yes -e gh_release
|
||||||
|
```
|
||||||
|
|
||||||
| Environment | Description |
|
| Environment | Description |
|
||||||
|-------------|-------------|
|
|-------------|-------------|
|
||||||
| `default` | Debug logging enabled, version from current git branch (recommended) |
|
| `default` | Debug logging enabled, version from current git branch (recommended) |
|
||||||
|
|||||||
Reference in new issue
Block a user