Skip to content

Commit e7833ac

Browse files
committed
Initial commit of Ankitty
Signed-off-by: Marvin A. Ruder <signed@mruder.dev>
1 parent 36c88df commit e7833ac

File tree

199 files changed

+86
-248
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

199 files changed

+86
-248
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77

88
*Please replace the space inside the brackets with an **x** and fill out the ellipses if the following items apply:*
99

10-
- [ ] I've read and understood the [contribution guidelines](./CONTRIBUTING.md)
1110
- [ ] I've tested my changes against at least one of the following [Anki builds](https://apps.ankiweb.net/#download):
1211
- [ ] Latest standard Anki 2.1 binary build [required for Anki-compatible 2.1 add-ons]
1312
- [ ] Latest alternative Anki 2.1 binary build

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Linux FM
22
.hidden
33
.directory
4+
# macOS
5+
.DS_Store
46
# Byte-compiled / optimized / DLL files
57
*.pyo
68
*.pyc

CHANGELOG.md

Lines changed: 0 additions & 140 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

README.md

Lines changed: 19 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,22 @@
1-
<p align="center"><img src="screenshots/reviewer.gif" height=500></p>
2-
3-
<h2 align="center">Puppy Reinforcement for Anki</h2>
1+
<h2 align="center">Kitten Reinforcement for Anki</h2>
42

53
<p align="center">
6-
<a title="Latest (pre-)release" href="https://github.com/glutanimate/puppy-reinforcement/releases"><img src ="https://img.shields.io/github/release-pre/glutanimate/puppy-reinforcement.svg?colorB=brightgreen"></a>
7-
<a title="License: GNU AGPLv3" href="https://github.com/glutanimate/puppy-reinforcement/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-GNU AGPLv3-green.svg"></a>
8-
<a title="Rate on AnkiWeb" href="https://ankiweb.net/shared/info/1722658993"><img src="https://glutanimate.com/logos/ankiweb-rate.svg"></a>
4+
<a title="Latest (pre-)release" href="https://github.com/marvinruder/ankitty/releases"><img src ="https://img.shields.io/github/release-pre/marvinruder/ankitty.svg?colorB=brightgreen"></a>
5+
<a title="License: GNU AGPLv3" href="https://github.com/marvinruder/ankitty/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-GNU AGPLv3-green.svg"></a>
6+
<a title="Rate on AnkiWeb" href="https://ankiweb.net/shared/info/1319623242"><img src="https://glutanimate.com/logos/ankiweb-rate.svg"></a>
97
<br>
10-
<a title="Buy me a coffee :)" href="https://ko-fi.com/X8X0L4YV"><img src="https://img.shields.io/badge/ko--fi-contribute-%23579ebd.svg"></a>
11-
<a title="Support me on Patreon :D" href="https://www.patreon.com/bePatron?u=7522179"><img src="https://img.shields.io/badge/patreon-support-%23f96854.svg"></a>
12-
<a title="Follow me on Twitter" href="https://twitter.com/intent/user?screen_name=glutanimate"><img src="https://img.shields.io/twitter/follow/glutanimate.svg"></a>
8+
<a title="Buy upstream maintainer a coffee :)" href="https://ko-fi.com/X8X0L4YV"><img src="https://img.shields.io/badge/ko--fi-contribute%20upstream-%23579ebd.svg"></a>
9+
<a title="Support upstream maintainer on Patreon :D" href="https://www.patreon.com/bePatron?u=7522179"><img src="https://img.shields.io/badge/patreon-support%20upstream-%23f96854.svg"></a>
1310
</p>
1411

15-
> Everything's better with puppies!
12+
> Everything's better with kittens!
1613
17-
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.
14+
An add-on for the spaced-repetition flashcard app [Anki](https://apps.ankiweb.net/) that encourages learners with pictures of cute kittens, following the principles of intermittent positive reinforcement.
1815

1916
### Table of Contents <!-- omit in toc -->
2017

2118
<!-- MarkdownTOC levels="1,2,3" -->
2219

23-
- [Video](#video)
2420
- [Installation](#installation)
2521
- [Documentation](#documentation)
2622
- [Building](#building)
@@ -29,37 +25,27 @@ An add-on for the spaced-repetition flashcard app [Anki](https://apps.ankiweb.ne
2925

3026
<!-- /MarkdownTOC -->
3127

32-
### Video
33-
34-
A quick demo of the add-on (alongside other similar add-ons related to gamification):
35-
36-
[![YouTube: Anki add-on guide: Gamify Your Reviews](https://i.ytimg.com/vi/UkveLkAgXiM/mqdefault.jpg)](https://youtu.be/UkveLkAgXiM)
37-
3828
### Installation
3929

4030
#### AnkiWeb <!-- omit in toc -->
4131

42-
The easiest way to install Puppy Reinforcement is through [AnkiWeb](https://ankiweb.net/shared/info/1722658993).
32+
The easiest way to install Ankitty is through [AnkiWeb](https://ankiweb.net/shared/info/1319623242).
4333

4434
#### Manual installation <!-- omit in toc -->
4535

46-
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)
36+
1. Download the latest `.ankiaddon` file from the [releases tab](https://github.com/marvinruder/ankitty/releases) (you might need to click on *Assets* below the description to reveal the download links)
4737
2. Open the folder where your downloads are located and double-click on the downloaded `.ankiaddon` file.
4838
3. Follow the installation prompt and restart Anki if it asks you to
4939

5040
<details>
5141

5242
<summary><i>Alternate option</i></summary>
5343

54-
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)
44+
1. Download the latest `.ankiaddon` package from the [releases tab](https://github.com/marvinruder/ankitty/releases) (you might need to click on *Assets* below the description to reveal the download links)
5545
2. From Anki's main window, head to *Tools**Add-ons*
5646
3. Drag-and-drop the `.ankiaddon` package onto the add-ons list
5747
4. Restart Anki
5848

59-
Video summary:
60-
61-
<img src="https://raw.githubusercontent.com/glutanimate/docs/master/anki/add-ons/media/ankiaddon-installation-macos.gif" width=640>
62-
6349
</details>
6450

6551
### Documentation
@@ -70,34 +56,32 @@ For further information on the use of this add-on please check out [the descript
7056

7157
With [Anki add-on builder](https://github.com/glutanimate/anki-addon-builder/) installed:
7258

73-
git clone https://github.com/glutanimate/puppy-reinforcement.git
74-
cd puppy-reinforcement
59+
git clone https://github.com/marvinruder/ankitty.git
60+
cd ankitty
7561
aab build
7662

7763
For more information on the build process please refer to [`aab`'s documentation](https://github.com/glutanimate/anki-addon-builder/#usage).
7864

7965
### Contributing
8066

81-
Contributions are welcome! Please review the [contribution guidelines](./CONTRIBUTING.md) on how to:
82-
83-
- Report issues
84-
- File pull requests
85-
- Support the project as a non-developer
67+
Contributions are welcome!
8668

8769
### License and Credits
8870

71+
*Ankitty*, a fork of *[Puppy Reinforcement](https://github.com/glutanimate/puppy-reinforcement)*, is *Copyright © 2024 [Marvin A. Ruder](https://github.com/marvinruder) (marvinruder)*
72+
8973
*Puppy Reinforcement* is *Copyright © 2016-2023 [Aristotelis P.](https://glutanimate.com/) (Glutanimate)*
9074

9175
With code contributions from: [@zjosua](https://github.com/zjosua) (thanks!)
9276

93-
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.
77+
Ankitty 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/marvinruder/ankitty/blob/main/LICENSE) file that accompanied this program.
9478

95-
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.
79+
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/marvinruder/ankitty/blob/main/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.
9680

9781
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.
9882

9983
----
10084

10185
<b>
102-
<div align="center">The continued development of this add-on is made possible <br>thanks to my <a href="https://www.patreon.com/glutanimate">Patreon</a> supporters. You guys rock ❤️ !</div>
86+
<div align="center">The continued development of this add-on is made possible <br>thanks to the upstream maintainer’s <a href="https://www.patreon.com/glutanimate">Patreon</a> supporters.</div>
10387
</b>

addon.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
2-
"display_name": "Puppy Reinforcement",
3-
"module_name": "puppy_reinforcement",
4-
"repo_name": "puppy-reinforcement",
5-
"ankiweb_id": "1722658993",
6-
"author": "Glutanimate",
7-
"contact": "https://glutanimate.com",
8-
"homepage": "https://github.com/glutanimate/puppy-reinforcement",
9-
"copyright_start": 2016,
10-
"tags": "reviewer conditioning reinforcement gamification doggos",
2+
"display_name": "Ankitty",
3+
"module_name": "ankitty",
4+
"repo_name": "ankitty",
5+
"ankiweb_id": "1319623242",
6+
"author": "Marvin A. Ruder",
7+
"contact": "https://github.com/marvinruder",
8+
"homepage": "https://github.com/marvinruder/ankitty",
9+
"copyright_start": 2024,
10+
"tags": "reviewer conditioning reinforcement gamification cats",
1111
"conflicts": [],
1212
"targets": ["anki21"],
1313
"min_anki_version": "2.1.49"

0 commit comments

Comments
 (0)