diff --git a/README.md b/README.md index 3f6b4f80743727c9bcca52c879423f02ae5fb794..13b72836d64fa382ddfad1c4d7262a9aeb0104d8 100644 --- a/README.md +++ b/README.md @@ -2,29 +2,29 @@ # Moody # This software is in alpha: it still has some rough edges. -For example there is still no support for folders in master. +For example the username setup require restarting the app; I ignore why. See [CONTRIBUTING.md](/CONTRIBUTING.md) for informations about how it works. ## Quick Install ## -For Arch Linux, there is the [https://aur.archlinux.org/packages/epfl-moody-git/](epfl-moody-git) AUR package. +For Arch Linux, there is the [epfl-moody-git](https://aur.archlinux.org/packages/epfl-moody-git/) AUR package. Fedora and Debian packages are planned. ### Flatpak ### +(for it to work, you may need to [install flatpak](https://flatpak.org/setup/)) + You can also install using flatpak, which should work for every Linux distribution ```sh flatpak-builder --install-deps-from=flatpak --install --user --force-clean _flatbuild ch.gnugen.Moody.json ``` For some reason, you may need to install elfutils `sudo apt install elfutils` -Flatpak will build libhandy and myhtml from their repositry, and use libsoup and libsecret +Flatpak will build libhandy and myhtml from their repository, and use libsoup and libsecret from the Gnome runtime. You can also install it system-wide by removing the `--user` flags. -you may need to [https://flatpak.org/setup/](install flatpak) for it to work - ## Build it Yourself ## ### Gnome Builder ### @@ -36,7 +36,7 @@ and ask it to clone the repositry. Have a look at the code while it gets the dep Alternatively, you can install it system-wide outside of the flatpak sandbox; -You first need to install [https://github.com/lexborisov/myhtml](myhtml) +You first need to install [myhtml](https://github.com/lexborisov/myhtml) or the modest rendering engine; libhandy, libsecret and libsoup. You may find these in your repos.