Loupe/README.md
2022-11-22 19:54:10 -05:00

37 lines
1.4 KiB
Markdown

# Loupe
A simple image viewer application written with GTK4 and Rust.
## MVP TODO
* [ ] Hover timeout for buttons and fullscreen headerbar
* [x] Pan/zoom
* [x] Back/forward navigation
## Building
### GNOME Builder
GNOME Builder is the environment used for developing this application. It can use Flatpak manifests to create a consistent building and running environment cross-distro. Thus, it is highly
recommended you use it.
1. Download [GNOME Builder](https://flathub.org/apps/details/org.gnome.Builder).
2. In Builder, click the "Clone Repository" button at the bottom, using `git@gitlab.gnome.org/BrainBlasted/loupe.git`
or `https://gitlab.gnome.org/BrainBlasted/loupe.git` as the URL.
3. Click the build button at the top once the project is loaded.
## Installation
Depending on how you want it installed instructions can differ. If you
used GNOME Builder to build it, clicking the bar at the top window will
open a submenu with "Export Bundle". This will create a flatpak bundle,
which can be installed on any system that supports flatpak.
**In order for the Loupe flatpak to be able to read the directory images are installed in, you must install a bundle.**
Once you have a bundle installed, development builds will work properly.
## Conduct
Loupe operates under the GNOME Code Of Conduct. See the full
text of the Code Of Conduct [here](CODE_OF_CONDUCT.md).