Skip to content

Commit

Permalink
generate description for Anki web
Browse files Browse the repository at this point in the history
  • Loading branch information
gflohr committed Dec 13, 2023
1 parent f09198e commit ae6f208
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 8 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ src/manifest.json
src/meta.json
/build
/ankidata
/ankiweb-description.md
16 changes: 11 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

This project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.2] - 2023-12-12

### Fixed

* update deck overview after import

### Changed

* modified project structure
* PGN files must now be in UTF-8

## [0.1.1] - 2023-12-01

### Added
Expand All @@ -12,11 +23,6 @@ This project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

* correct location of meta.json with configuration

### Changed

* modified project structure
* PGN files must now be in UTF-8

## [0.1.0] - 2023-11-21

### Added
Expand Down
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@ all: zip ankiweb
zip: vendor
python -m ankiscripts.build --type package --qt all --exclude user_files/**/*

ankiweb: vendor
ankiweb: vendor build/ankiweb-description.md
python -m ankiscripts.build --type ankiweb --qt all --exclude user_files/**/*

build/ankiweb-description.md: description.md CHANGELOG.md
cat description.md CHANGELOG.md >$@

vendor:
python -m ankiscripts.vendor

Expand Down
9 changes: 7 additions & 2 deletions description.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Chess Opening Trainer

This extension creates a deck with chess openings from a collection of chess
games in PGN format. If you select "white" as the colour, when importing the
file, all black moves become questions, and all white replies to that move
Expand All @@ -14,3 +12,10 @@ on both sides of the notes.

See the [github page](htttps://github.com/gflohr/anki-chess-opening-trainer)
for more information!

There is a also a blog post that describes the add-on and its concept in
great detail:

* English version: http://www.guido-flohr.net/practice-chess-openings-with-anki/
* German version: http://www.guido-flohr.net/schach-eroeffnungen-mit-anki-trainieren/

0 comments on commit ae6f208

Please sign in to comment.