Skip to content

Add build instructions #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eljamm wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add build instructions #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c5d272
Build anki-review-heatmap.js from source
eljamm Jun 8, 2025
4b9c7f7
Add build instructions
eljamm Jun 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,28 @@ The use of the add-on is documented in the [Wiki section](https://github.com/Glu

### Building

Review Heatmap's build system recently underwent a number of changes. Updated build instructions will soon be added here. Please stand by.
#### Manual

Requirements:

- nodejs
- [anki-addon-builder](https://github.com/glutanimate/anki-addon-builder)

Install dependencies:

```shellSession
npm install
```

Build the addon:

```shellSession
$ aab build
$ npm run build
$ aab package_dist
```

You will find the ankiaddon file under the `build/` directory.

### Contributing

Expand Down
Loading