diff options
| -rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c70bad3 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Muddle (Work in progress!) +A desktop Moodle client, because the web interface is painfully slow if you quickly need to grab a file. + +## Configuration +On linux, copy `muddle.ini.sample` to `~/.config/muddle/muddle.ini` and add a token. +On other platforms there is no specific path implemented yet, so it will look for a file `muddle.ini` in the same folder as the executable. + +## Development +This is written in Python 3 + PyQt. Virtualenv is probably the most comfortable way to work. +If you don't know how to set up a venv, type in you terminal (while in the project directory): +```bash +muddle $ python3 -m venv venv +muddle $ source ./venv/bin/activate +muddle $ pip3 install -r requirements.txt +muddle $ ./muddle --gui +``` + +The code is a bit garbage, as I hacked it toghether in one morning, though I've tried to clean it up a bit. |