Skip to content

Commit ff06adf

Browse files
committed
feat: begin writing roseate section in apps
1 parent 4f821b7 commit ff06adf

File tree

7 files changed

+70
-21
lines changed

7 files changed

+70
-21
lines changed

docs/apps/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
# Applications
2-
<s>meow</s> WIP!
2+
3+
- 🌹 [Roseate](./roseate/index.md) - *Our fast, GPU accelerated and cross-platform image viewer...*
47.1 KB
Loading

docs/apps/roseate/index.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# 🌹 Roseate
2+
![showcase image](./showcase_1.png)
3+
4+
!!! warning
5+
If you're looking for an [installation guide](./installation.md), there isn't one at the moment because Roseate is still <ins>**work in progress**</ins> and has not released yet.
6+
7+
> Roseate is a **free** and **open-source**, GPU accelerated, cross-platform and simplistic image viewer that's highly configurable and fast.
8+
9+
Being a cloudy-org application, it naturally follows the [Cloudy Philosophy](https://github.com/cloudy-org/.github/blob/main/philosophy.md).
10+
11+
It's designed to be **lightweight**, **privacy-respecting** and **stupidly fast** to launch and display images.
12+
13+
![placeholder image]()
14+
15+
## 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).
17+
18+
## How to use?
19+
!!! info
20+
At the moment this wiki assumes you're on Linux, support for other platforms (Windows & MacOS) is work in progress and half-baked. If you're on these platforms and you're happy to help, we'll be very grateful if you can compile the image viewer and [report your issues to us](https://github.com/cloudy-org/roseate/issues). Additionally edits to [this wiki](https://github.com/cloudy-org/wiki/edit/main/docs/apps/roseate/index.md) would be great.
21+
22+
Welcome to this quick guide on how to use the Roseate image viewer. **It's simple!**
23+
24+
### Launching the image viewer
25+
Roseate can be launched in **3** primary ways, [if setup correctly](./setup.md):
26+
27+
1) Your terminal, by executing the binary.
28+
29+
```sh title="terminal"
30+
roseate
31+
```
32+
33+
2) Through your application launcher (or start menu).
34+
35+
![application launcher](./application_launcher.png)
36+
37+
3) Or by clicking an image.
38+
39+
![launch with image](./launch_with_image.png)
40+
41+
<br>
42+
43+
***THIS WIKI IS STILL WIP...***
28.2 KB
Loading

docs/apps/roseate/showcase_1.png

518 KB
Loading

mkdocs.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,19 @@ plugins:
88
- search
99
- section-index
1010

11+
markdown_extensions:
12+
- admonition
13+
- pymdownx.details
14+
- pymdownx.superfences
15+
1116
theme:
1217
name: material
1318
logo: assets/clouds.png
1419
favicon: assets/clouds.png
1520
icon:
1621
repo: octicons/git-merge-16
1722
font:
18-
text: Roboto Mono
23+
text: Roboto
1924
palette:
2025
scheme: slate
2126
primary: red

uv.lock

Lines changed: 19 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)