Skip to content

Commit 809f5e7

Browse files
committed
docs(wiki): expand on roseate configuration and add settings menu page
1 parent 690f956 commit 809f5e7

6 files changed

Lines changed: 52 additions & 12 deletions

File tree

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Advanced Configuration
2+
3+
!!! warning
4+
This section is for **advanced configuration**. You can configure Roseate with ease via the **[Settings Menu](../../misc/settings_menu.md)**.
5+
6+
Roseate is in alpha, expect sudden breaking changes in `config.toml`.
7+
8+
The config file for the Roseate image viewer can be accessed and edited with the `--edit` or `-e` command:
9+
10+
=== "Linux"
11+
12+
```sh title="terminal"
13+
roseate --edit
14+
```
15+
16+
=== "Windows"
17+
18+
```sh title="terminal"
19+
start roseate --edit
20+
```
21+
22+
!!! note
23+
The section below is automatically generated from Roseate's toml config template which you can find here: **[https://github.com/cloudy-org/roseate/blob/main/app/assets/config.template.toml](https://github.com/cloudy-org/roseate/blob/main/app/assets/config.template.toml)**
24+
25+
Hence to help edit this section you will need to edit the docstring in the toml template directly over at the Roseate repo.
26+
27+
!!! warning
28+
This section is in an experimental testing stage; it's very rough around the edges. Contributions to improve my code are welcome.
29+
30+
--8<-- "roseate-config-gen.md"

docs/apps/roseate/advanced_installs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
--8<-- "wip-page.md"
44

55
!!! warning
6-
This is the advanced installation guide. If you're new you'll want the **[Installation Guide](./installation.md)** instead.
6+
This is the **advanced installation** guide. If you're new you'll want the **[Installation Guide](./installation.md)** instead.
77

88
## Roseate Slim (aka basic)
99
Roseate slim is the lean and basic version of [Roseate](./index.md) that excludes all the additional features such as the image exif location button and less common file formats.

docs/apps/roseate/configuration.md

Lines changed: 0 additions & 11 deletions
This file was deleted.
133 KB
Loading

docs/misc/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Miscellaneous
2+
3+
Documentation that currently doesn't have a special location.
4+
5+
- [Settings Menu](./settings_menu.md)

docs/misc/settings_menu.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Settings Menu
2+
3+
Most cloudy-org **egui** applications using the **[cirrus](https://github.com/cloudy-org/cirrus)** toolkit have a settings menu you can access with the `CTRL + ,` key bind.
4+
5+
![roseate settings menu](../assets/roseate_settings_menu.png)
6+
7+
> Settings menu from **[Roseate](../apps/roseate/index.md)**.
8+
9+
## Exiting
10+
To exit the menu press `ESC` or `CTRL + ,` (again).
11+
12+
## Saving
13+
You can press `CTRL + S` to **force save** your settings, otherwise they will be saved upon exit one way or another.
14+
15+
## Supported Applications
16+
- [Roseate](../apps/roseate/index.md)

0 commit comments

Comments
 (0)