From 33767a83f7ac32e182101bb0a9333a1f9395a158 Mon Sep 17 00:00:00 2001 From: Frederick Yin Date: Tue, 25 Jul 2023 14:58:38 +0800 Subject: Better build instructions --- README.md | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0cb3f94..e8b7407 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,12 @@ Kanvas is a plasmoid that syncs announcements and assignments from your university's Canvas®™© LMS to your Plasma desktop. It lacks features and -configs, and I would not say it is not production-ready. +configs, and I would not say it is production-ready. Kanvas is written in QML. It is the first QML application I wrote and I have not touched JavaScript in two years, so the code sucks. -ight now, it looks like this: +Right now, it looks like this: ![Screenshot](img/screenshot_0.1.1.png) @@ -19,20 +19,18 @@ development experience like me, here are some useful links: - [Techbase: Plasma 5](https://techbase.kde.org/Development/Tutorials/Plasma5) - [Developer: Plasma Widget Testing](https://develop.kde.org/docs/plasma/widget/testing/) -My workflow as of now is a simple Makefile. Run `make install` to install -the plasmoid to your `~/.local/share/plasma/plasmoids/`, then `make` to -run it in a window (`plasmawindowed`). Each time you `make`, the plasmoid -in `.local/` will be updated. - -At startup you will see sample announcement/assignments. They are for -layout tweaking in the early stages of development. Before doing anything -you will need to configure the plasmoid. Right click the "Kanvas" heading -and click "Configure Kanvas". Go to the "Canvas" tab and fill out your -Canvas domain and OAuth2 token. Click "Fetch courses", then follow -instructions on the UI. Click "OK" to save. The configuration will be -saved for plasmawindowed every time you debug, but kept separate from the -rest of Plasma; if you add the widget to your desktop it has to be -configured again. +After you clone this repo, run `make install` to copy the plasmoid to +`~/.local/share/plasma/plasmoids/`. You need to run it only once. + +Every time you want to test Kanvas, run `make` to update the plasmoid in +`~/.local/` and run it in a window (`plasmawindowed`). + +Then, configure the plasmoid. Right click the "Kanvas" heading and click +"Configure Kanvas". Go to the "Canvas" tab and fill out your Canvas domain +and OAuth2 token. Click "Fetch courses", then follow instructions on the +UI. Click "OK" to save. The configuration will be saved for plasmawindowed +every time you debug, but kept separate from the rest of Plasma; if you +add the widget to your desktop it has to be configured again. ## Todo -- cgit v1.2.3