Skip to content

Commit c67f38c

Browse files
committed
Merge patch glutanimate#210
Thanks to @eljamm for the updated build instructions, they have been added to this fork
1 parent b796468 commit c67f38c

5 files changed

Lines changed: 504 additions & 6 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ venv/
1616
ENV/
1717
env.bak/
1818
venv.bak/
19+
.DS_Store
20+
1921
# Javascript
2022
node_modules
2123
# IDEs

README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,17 @@ Adds a **heatmap graph** to [Anki](https://apps.ankiweb.net/)'s main window whic
2323
- [AnkiWeb](#ankiweb)
2424
- [Documentation](#documentation)
2525
- [Building](#building)
26+
- [Manual](#manual)
2627
- [Contributing](#contributing)
2728
- [License and Credits](#license-and-credits)
2829

2930
<!-- /MarkdownTOC -->
3031

3132
### Video Demonstration
3233

33-
General Overview | Customization
34-
---------|----------
35-
[![YouTube: Anki add-on: Review Heatmap](https://i.ytimg.com/vi/3Hk5TYdvKnM/mqdefault.jpg)](https://youtu.be/3Hk5TYdvKnM) | [![YouTube: Add-on Update: Review Heatmap](https://i.ytimg.com/vi/2u8p0N47eUg/mqdefault.jpg)](https://youtu.be/2u8p0N47eUg)
34+
| General Overview | Customization |
35+
| ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
36+
| [![YouTube: Anki add-on: Review Heatmap](https://i.ytimg.com/vi/3Hk5TYdvKnM/mqdefault.jpg)](https://youtu.be/3Hk5TYdvKnM) | [![YouTube: Add-on Update: Review Heatmap](https://i.ytimg.com/vi/2u8p0N47eUg/mqdefault.jpg)](https://youtu.be/2u8p0N47eUg) |
3637

3738
(Make sure to enable closed-captions for comments on the demonstrated features)
3839

@@ -54,7 +55,28 @@ The use of the add-on is documented in the [Wiki section](https://github.com/Glu
5455

5556
### Building
5657

57-
Review Heatmap's build system recently underwent a number of changes. Updated build instructions will soon be added here. Please stand by.
58+
#### Manual
59+
60+
Requirements:
61+
62+
- nodejs
63+
- [anki-addon-builder](https://github.com/glutanimate/anki-addon-builder)
64+
65+
Install dependencies:
66+
67+
```shellSession
68+
npm install
69+
```
70+
71+
Build the addon:
72+
73+
```shellSession
74+
$ uvx --from "git+https://github.com/glutanimate/anki-addon-builder.git#egg=aab[qt5,qt6]" aab build
75+
$ npm run build
76+
$ uvx --from "git+https://github.com/glutanimate/anki-addon-builder.git#egg=aab[qt5,qt6]" aab package_dist
77+
```
78+
79+
You will find the ankiaddon file under the `build/` directory.
5880

5981
### Contributing
6082

0 commit comments

Comments
 (0)