Skip to content
Snippets Groups Projects
Commit 9456608d authored by Antoine Fontaine's avatar Antoine Fontaine :8ball:
Browse files

Udated information, better build instructions

parent 505ce911
Branches
Tags
No related merge requests found
......@@ -5,47 +5,47 @@ This software is in alpha: it still has some rough edges.
For example In the current state, you must set you username
at compile time (see `USERNAME` in config.h.in).
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.
Fedora and Debian packages are planned.
If you are using Gnome or KDE, you can also open the file
[https://gitlab.gnugen.ch/afontain/moodle/raw/master/ch.gnugen.Moody.flatpakref](here);
otherwise, `flatpak install --user https://gitlab.gnugen.ch/afontain/moodle/raw/master/ch.gnugen.Moody.flatpakref`
### Flatpak ###
You can also install using flatpak, which should work for every Linux distribution
```sh
flatpak-builder --install --user --force-clean _flatbuild ch.gnugen.Moody.json
```
Flatpak will build libhandy and myhtml from their repositry, and use librest
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 ###
If you are fond of graphical interfaces, get Gnome Builder (`flatpak install org.gnome.Builder`),
ask it to clone the repositry, have a look at the code while it gets the dependancies.
To build and lauch the app, just press the exec button.
### Flatpak, the hard way ###
```sh
flatpak-builder --repo=repo --force-clean build-dir ch.gnugen.Moody.json
flatpak remote-add moodlerepo repo --no-gpg-verify --user
flatpak install moodlerepo ch.gnugen.Moody.json --user
flatpak run ch.gnugen.Moody.json
```
You can also install it system-wide by removing the two `--user` flags.
If you are fond of graphical interfaces, get Gnome Builder (`flatpak install org.gnome.Builder`)
and ask it to clone the repositry. Have a look at the code while it gets the dependencies!
### Meson ###
Alternatively, you can install it system-wide outside of the flatpak sandbox;
You first need to install [https://github.com/lexborisov/myhtml](myhtml)
or the modest rendering engine; libhandy, and librest.
You may find these in your repos.
```sh
git clone https://gitlab.gnugen.ch/afontain/moodle.git
meson build-dir
ninja -C build-dir
ninja -C build-dir install
```
You need to install [https://github.com/lexborisov/myhtml](myhtml),
or the modest rendering engine before (in your repo).
Although it should work, I haven't tested everything works that way.
## Features ##
......@@ -59,8 +59,5 @@ with files, yet.
## Future Work ##
There is an awful lot to do: cleanup, sane build method,
making use of GLib's GTask, intelligent use of cache,
an ability to read files inside folders…
See [CONTRIBUTING.md](/CONTRIBUTING.md) for informations on how it works.
There is a lot to do: making use of GLib's GTask, loading courses
from use of cache intelligently, adding the ability to read files inside folders…
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