Skip to content

Commit

Permalink
Merge branch 'pr-2'
Browse files Browse the repository at this point in the history
  • Loading branch information
Heikki Ketoharju committed Jan 10, 2024
2 parents f9de867 + 4bd20c9 commit 054901f
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 20 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ First, obtain code by doing a git clone:

Then, you can either follow these commands manually or just execute all targets in Makefile.

First, you need to set up a virtual environment. Of course, this is not mandatory, but pretty handy.
First, you need to set up a virtual environment.

I like to place my virtual env in hidden directory called `.venv`.

python -m venv .venv
python3 -m venv .venv

or:

Expand Down
15 changes: 10 additions & 5 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,24 @@

You can install this program by just downloading a binary file from releases and running it on your computer.

If you don't know how to do that, there's also an deb-installation package for Ubuntu and probably other Debian-like operating systems.
If you don't know how to do that, there's also a deb-installation package for Ubuntu and probably other Debian-like operating systems.

[Head to releases and download this!](https://github.com/heikkiket/gallery/releases)
[Head to releases and download it!](https://github.com/heikkiket/gallery/releases)

If you aren't sure how to install and run these files, don't worry! This is an alpha level software, so if you can't install it, probably you couldn't use it either. Wait for few years and maybe this thing takes over the world! Then installation and usage will hopefully be easy.

### Installing PyGObject

**In Ubuntu (and hopefully Debian as well):**
If you downloaded a binary file, you need to install PyGObject by hand in order to run the gallery-viewer.

**On Ubuntu and Debian:**
Install following packages: `python3-gi python3-gi-cairo gir1.2-gtk-3.0`

**In Fedora:**
Install following packages: `python3-gobject gtk3`
**On Fedora:**
Install following packages: `python3-gobject gtk4`

**On Arch:**
Install following packages: `python3-gobject gtk4`

You can find more information and help about installing PyGObject from their official documentation: https://pygobject.readthedocs.io/en/latest/getting_started.html

Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ This project has three parts:
* simple viewer program

## Useful links
Before we hop to all that, here's some links that give you a quick jump to other parts of documentation
Before we hop to all that, here are some links that give you a quick jump to other parts of documentation

- [Installation](INSTALL.md)
- [Why a world needs an UNIX-style image collection manager?](docs/why.md)
- [Why a world needs a UNIX-style image collection manager?](docs/why.md)
- [Blog](docs/blog)

## gallery specification
Expand All @@ -22,16 +22,16 @@ Your image gallery is just a directory tree containing pictures plus a library.t
```
~/Pictures/gallery/
├── 2021
   └── 12
   └── 15
   └── image1.png
└── 12
└── 15
└── image1.png
├── 2022
   ├── 01
   │   └── 15
   │   └── image2.png
   └── 03
   └── 02
   └── image3.jpg
├── 01
└── 15
└── image2.png
└── 03
└── 02
└── image3.jpg
└── library.toml
```

Expand Down Expand Up @@ -72,7 +72,7 @@ The idea here is that the whole library.toml is easily hackable so you (or other

![Picture of gallery command line tool](./docs/screenshots/gallery-cmd.png)

There is a simple, alpha-level utility called `gallery` that can be used to manipulate this gallery. Currently it has following functions.
There is a simple, alpha-level utility called `gallery` that can be used to manipulate this gallery. Currently, it has the following functions.

* init
* list
Expand Down Expand Up @@ -127,7 +127,7 @@ In order to function gallery-viewer needs python3 installed in the host system a
Head to [INSTALL.md](INSTALL.md) to find out how!

## Check out changelog
I have a ugly but functional [CHANGELOG.md](CHANGELOG.md) generated with [git-cliff](https://github.com/orhun/git-cliff).
I have an ugly but functional [CHANGELOG.md](CHANGELOG.md) generated with [git-cliff](https://github.com/orhun/git-cliff).

## Want to contribute?
I value that greatly! Head on to [CONTRIBUTING.md](./CONTRIBUTING.md) to find out how to build the project.

0 comments on commit 054901f

Please sign in to comment.