🌹 roseate

_{A small and simple but fancy image viewer built with Rust & Typescript that's cross-platform.}

Caution

This project is HEAVILY a work in progress, hence it may crash or harm your system. Github issues are welcome. 🤝

🛠️ Installation

As Roseate is in heavy development I won't offer packages and binaries yet so you'll need to compile the application from source.

🏗 Build from source

Prerequisites:

npm
Tauri CLI ( cargo install tauri-cli )
Rust (must be 1.60+)
Make (recommended, otherwise you'll need to run commands from the Makefile manually)

Clone the repo.

git clone https://github.com/cloudy-org/roseate
cd roseate

Pull the submodules (includes ctk).

git submodule update --init --recursive

Install npm dependencies.

make install-deps

⚙️ For Development

At this stage, for development, you would just run make run. If you would like to install it to your system continue ahead to the next section.

Run make run.

make run

To run Roseate in development with an image use this make command:

make run ARGS="./anime_girl.png"

🎀 Install into your system.

Build the release binary.

make

Install to your system.

make install

Then the roseate binary will be available in your terminal.

roseate

Make sure to add ~/.cargo/bin to path. You can do so by adding export PATH=$PATH:~/.cargo/bin to your .bashrc or an equivalent. On Windows, it should already be in path.

Open an image by passing its path.

roseate ./anime_girls.png

You might want to also set the binary at ~/.cargo/bin/roseate as your default image viewer so double clicking on images calls it. Look up how to perform that for your desktop environment or OS.