summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFrederick Yin <fkfd@fkfd.me>2023-07-25 14:58:38 +0800
committerFrederick Yin <fkfd@fkfd.me>2023-07-25 14:58:38 +0800
commit33767a83f7ac32e182101bb0a9333a1f9395a158 (patch)
tree25cedbede15a66ea82a93d20aeb417f6e9d6a424 /README.md
parentda56d489b72fb567f7566f745763d76557f2d648 (diff)
Better build instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 14 insertions, 16 deletions
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