Skip to content

Commit

Permalink
docs: 📝 write an explanation for the sound card type
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreMacedo88 committed Feb 13, 2024
1 parent bbbae46 commit 42bca61
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Outside of these rules, you are free to populate your text file with other annot
# Current card types
Currently, the output deck will be populated with cards from one type at a time.
The currently implemented types are:
- `basic`: The basic card type in Anki. Each line's text is split between front and back of one card by the `separator`.
- `sound`: TODO: write a short description of the sound card type
- `basic`: The [Basic](https://docs.ankiweb.net/getting-started.html#card-types) card type in Anki. Each line's text is split between front and back of one card by the `separator`
- `sound`: Similar to the [Basic (type in the answer)](https://docs.ankiweb.net/getting-started.html#card-types) card type, but with an added empty field on the back of the card that can be filled up afterwards with (for example) sound files by using an add-on such as [HyperTTS](https://ankiweb.net/shared/info/111623432)

# Installation
Make sure you have python installed (recommended version >= 3.10) and then run in the terminal/command-line:
Make sure you have python installed (recommended version >= 3.12) and then run in the terminal/command-line:
```
pip install anki_deck_from_text
```
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "anki_deck_from_text"
version = "1.2.1"
version = "1.3.0"
description = "Generate an Anki deck from annotations on a text file"
authors = ["Andre Macedo <[email protected]>"]
readme = "README.md"
Expand Down

0 comments on commit 42bca61

Please sign in to comment.