Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glutanimate/puppy-reinforcement
Puppy Reinforcement add-on for Anki
https://github.com/glutanimate/puppy-reinforcement
anki anki-addon education flashcards learning srs
Last synced: 13 days ago
JSON representation
Puppy Reinforcement add-on for Anki
- Host: GitHub
- URL: https://github.com/glutanimate/puppy-reinforcement
- Owner: glutanimate
- License: other
- Created: 2019-06-09T19:13:24.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-09T00:22:16.000Z (8 months ago)
- Last Synced: 2024-10-04T16:09:53.670Z (about 1 month ago)
- Topics: anki, anki-addon, education, flashcards, learning, srs
- Language: Python
- Homepage: https://ankiweb.net/shared/info/1722658993
- Size: 5.43 MB
- Stars: 15
- Watchers: 1
- Forks: 9
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Puppy Reinforcement for Anki
> Everything's better with puppies!
An add-on for the spaced-repetition flashcard app [Anki](https://apps.ankiweb.net/) that encourages learners with pictures of cute puppies, following the principles of intermittent positive reinforcement.
### Table of Contents
- [Video](#video)
- [Installation](#installation)
- [Documentation](#documentation)
- [Building](#building)
- [Contributing](#contributing)
- [License and Credits](#license-and-credits)
### Video
A quick demo of the add-on (alongside other similar add-ons related to gamification):
[](https://youtu.be/UkveLkAgXiM)
### Installation
#### AnkiWeb
The easiest way to install Puppy Reinforcement is through [AnkiWeb](https://ankiweb.net/shared/info/1722658993).
#### Manual installation
1. Download the latest `.ankiaddon` file from the [releases tab](https://github.com/glutanimate/puppy-reinforcement/releases) (you might need to click on *Assets* below the description to reveal the download links)
2. Open the folder where your downloads are located and double-click on the downloaded `.ankiaddon` file.
3. Follow the installation prompt and restart Anki if it asks you to
Alternate option
1. Download the latest `.ankiaddon` package from the [releases tab](https://github.com/glutanimate/puppy-reinforcement/releases) (you might need to click on *Assets* below the description to reveal the download links)
2. From Anki's main window, head to *Tools* → *Add-ons*
3. Drag-and-drop the `.ankiaddon` package onto the add-ons list
4. Restart Anki
Video summary:
### Documentation
For further information on the use of this add-on please check out [the description text](docs/description.md) for AnkiWeb.
### Building
With [Anki add-on builder](https://github.com/glutanimate/anki-addon-builder/) installed:
git clone https://github.com/glutanimate/puppy-reinforcement.git
cd puppy-reinforcement
aab build
For more information on the build process please refer to [`aab`'s documentation](https://github.com/glutanimate/anki-addon-builder/#usage).
### Contributing
Contributions are welcome! Please review the [contribution guidelines](./CONTRIBUTING.md) on how to:
- Report issues
- File pull requests
- Support the project as a non-developer
### License and Credits
*Puppy Reinforcement* is *Copyright © 2016-2023 [Aristotelis P.](https://glutanimate.com/) (Glutanimate)*
With code contributions from: [@zjosua](https://github.com/zjosua) (thanks!)
Puppy Reinforcement is free and open-source software. The add-on code that runs within Anki is released under the GNU AGPLv3 license, extended by a number of additional terms. For more information please see the [LICENSE](https://github.com/glutanimate/puppy-reinforcement/blob/master/LICENSE) file that accompanied this program.
Please note that this program uses the [Libaddon](https://github.com/glutanimate/anki-libaddon/) library which comes with [its own additional terms extending the GNU AGPLv3 license](https://github.com/glutanimate/puppy-reinforcement/blob/master/src/puppy_reinforcement/libaddon/LICENSE). You may only copy, distribute, or modify the present compilation of this program with Libaddon under the combined licensing terms specified by both licenses.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.
----
The continued development of this add-on is made possible
thanks to my Patreon supporters. You guys rock ❤️ !