README.md 1.97 KB
Newer Older
1
2
3
4
5
6
7
8
# <a href="https://gabmus.gitlab.io/notorious"><img height="32" src="data/icons/org.gabmus.notorious.svg" /> Notorious</a>

Keyboard centric notes

![screenshot](https://gitlab.gnome.org/GabMus/notorious/raw/website/website/screenshots/mainwindow.png)

## Notes on the distribution of this app

9
I decided to target flatpak mainly. It's just another package manager at the end of the day, but it's supported by many Linux distributions. It bundles all of the dependencies you need in one package.
10

11
This helps a lot in supporting many different distros because I know which version of which dependency you have installed, so I don't have to mess with issues caused by version mismatches. If you want to report an issue, feel free to. But please at least first see if this issue happens with the flatpak version as well.
12

13
As for development it's a similar story. I do most of my testing directly inside a flatpak sandbox and you should do the same. It's easy to set up, just open up this repo in GNOME Builder and press the run button. It will handle the rest.
14

15
# Installing from Flathub
16
17
18

You can install Notorious via [Flatpak](https://flathub.org/apps/details/org.gabmus.notorious).

19
# Installing from AUR
20
21
22
23
24
25
26
27
28

Notorious is available as an AUR package: [`notorious-git`](https://aur.archlinux.org/packages/notorious-git/).

<!--
## Installing from Fedora

Notorious is available in [Fedora repos](https://apps.fedoraproject.org/packages/notorious): `sudo dnf install notorious`
-->

29
# Building
30

31
**Note**: these are illustrative instructions. If you're a developer or a package maintainer, they can be useful to you. If not, just install the flatpak.
32

33
## Dependencies
34

35
`gtk3 python libhandy python-gobject gobject-introspection gtksourceview4`
36

37
## Build dependencies
38

39
40
41
`git meson`

## Building 
42

43
```bash
44
45
46
47
48
49
50
51
52
git clone https://gitlab.gnome.org/GabMus/notorious
cd notorious
mkdir build
cd build
meson ..
meson configure -Dprefix=$PWD/testdir # use this line if you want to avoid installing system wide
ninja
ninja install
```