Skip to content

🌹 A small and simple but fancy image viewer built with Rust & Typescript that's cross platform.

License

Notifications You must be signed in to change notification settings

cloudy-org/roseate

Repository files navigation

🌹 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:

  1. Clone the repo.
git clone https://github.com/cloudy-org/roseate
cd roseate
  1. Pull the submodules (includes ctk).
git submodule update --init --recursive
  1. 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.

  1. 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.

  1. Build the release binary.
make
  1. Install to your system.
sudo make install
  1. Then the roseate binary will be available in your terminal.
roseate

Open an image by passing its path.

roseate ./anime_girls.png

You might want to also set the binary at /usr/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.

About

🌹 A small and simple but fancy image viewer built with Rust & Typescript that's cross platform.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published