Commit af029867 authored by Gabriele Musco's avatar Gabriele Musco
Browse files

simplified readme, added dependencies list (#22 gnomegitlab)

parent f9b9c947
Pipeline #187931 passed with stage
in 2 minutes and 45 seconds
......@@ -6,24 +6,17 @@ Keyboard centric notes
## Notes on the distribution of this app
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.
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.
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.
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.
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.
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.
## Installing from Flathub
# Installing from Flathub
You can install Notorious via [Flatpak](https://flathub.org/apps/details/org.gabmus.notorious).
## Installing from AUR
# Installing from AUR
Notorious is available as an AUR package: [`notorious-git`](https://aur.archlinux.org/packages/notorious-git/).
......@@ -33,29 +26,21 @@ Notorious is available as an AUR package: [`notorious-git`](https://aur.archlinu
Notorious is available in [Fedora repos](https://apps.fedoraproject.org/packages/notorious): `sudo dnf install notorious`
-->
# Building on different distributions
# Building
**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.
**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.
## Building on Ubuntu/Debian
## Dependencies
```bash
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
```
`gtk3 python libhandy python-gobject gobject-introspection gtksourceview4`
## Building on Arch/Manjaro
## Build dependencies
```bash
sudo pacman -S python-gobject
`git meson`
## Building
```bash
git clone https://gitlab.gnome.org/GabMus/notorious
cd notorious
mkdir build
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment