Skip to content

Commit 188e657

Browse files
committed
feat: add some wip docs on opening images
1 parent bc44b30 commit 188e657

File tree

4 files changed

+21
-3
lines changed

4 files changed

+21
-3
lines changed

docs/apps/roseate/index.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It's designed to be **lightweight**, **privacy-respecting** and **stupidly fast*
1313
![placeholder image]()
1414

1515
## Background
16-
Roseate has been a passion project for [me](https://devgoldy.xyz) to learn the 🦀 Rust programming language, while also laying the groundwork for shared infrastructure across cloudy-org (like the [cirrus](https://github.com/cloudy-org/cirrus) tool-kit).
16+
Roseate has been a passion project for [me](https://devgoldy.xyz) to learn the 🦀 Rust programming language, while also laying the groundwork for shared infrastructure across cloudy-org (like the [cirrus](https://github.com/cloudy-org/cirrus) tool-kit). Roseate actually begun as a [tauri](https://tauri.app/) web app but I wasn't happy with the memory usage and performance. Hence I switched to [Egui](https://github.com/emilk/egui) which currently runs natively via OpenGL, and ever since it's been pretty performant. Along the way, the switch has also been a great learning experience.
1717

1818
## How to use?
1919
!!! info
@@ -34,10 +34,26 @@ roseate
3434

3535
![application launcher](./application_launcher.png)
3636

37-
3) Or by clicking an image.
37+
3) Or by normally opening an image.
3838

3939
![launch with image](./launch_with_image.png)
4040

41-
<br>
41+
### Opening an image
42+
You can open an image in **2** primary ways:
43+
44+
1) Clicking on the **Open Image** button or the 🌹 **rose**, then selecting an image.
45+
46+
![open image button](./open_image.gif)
47+
![select image button](./select_image.gif){: style="height:350px"}
48+
49+
2) Opening an image in your file explorer (as hinted previously).
50+
51+
3) Or by dragging and dropping into the viewer.
4252

53+
!!! failure
54+
Drag and dropping files currently doesn't work on Linux **with Wayland** yet.
55+
56+
![placeholder image]()
57+
58+
<br>
4359
***THIS WIKI IS STILL WIP...***

docs/apps/roseate/open_image.gif

510 KB
Loading

docs/apps/roseate/select_image.gif

5.18 MB
Loading

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ markdown_extensions:
1212
- admonition
1313
- pymdownx.details
1414
- pymdownx.superfences
15+
- attr_list
16+
- md_in_html
1517

1618
theme:
1719
name: material

0 commit comments

Comments
 (0)