Skip to content
Snippets Groups Projects
Commit a90cca7b authored by Philipp Stadler's avatar Philipp Stadler
Browse files

docs: add simple README

parent deb1d0c3
Branches
Tags
1 merge request!1docs: add simple README
# Brand spanking new Anki Pack
# Your custom vocabulary
Hi, do you want to build your own vocabulary with Anki and want to take
advantage of a feature-rich template without writing any code?
......@@ -9,36 +9,11 @@ for the other packages, where you need to fill in more fields to get all the
functionality.
## Importing the pack to your phone or PC
Open _Deployments | Releases_ on the left, then click _Browse all APKGS…_ on
the newest release. There, click an APKG, download it, and import into Anki.
Open _[Deployments | Releases](https://gitlab.phaidra.org/kartenaale/packs/your-custom-vocabulary/-/releases) on the left, then click _Browse all APKGS…_ on
the newest release. There, click the only APKG, download it, and import into Anki.
If you are completely new to Anki and feel a bit lost, check out the user guide
in
[English](https://gitlab.phaidra.org/kartenaale/getting-started-with-anki/-/blob/main/GUIDE.md)
or
[German](https://gitlab.phaidra.org/kartenaale/getting-started-with-anki/-/blob/main/ANLEITUNG.md).
## Contributing
To add new content to this pack, either add `.apkg` files in the root next to
`content` to include them unchanged, OR add subfolders to `content/` with data
in the form of CSV, images or APKGs and an `.apkg-spec.yaml` file that
configures which HTML to use for the cards and how your data is laid out.
You can use the content in the starter template as your basis or just have a
look to see how it works:
* [content/Facts-from-CSV](https://gitlab.phaidra.org/kartenaale/templates/anki-pack/-/tree/main/content/Facts-from-CSV) for Q/A cards imported from a CSV file,
* [content/Bijection-from-CSV](https://gitlab.phaidra.org/kartenaale/templates/anki-pack/-/tree/main/content/Bijection-from-CSV) for cards that work both ways, where the answer is also a question,
* [content/Bijection-from-Images](https://gitlab.phaidra.org/kartenaale/templates/anki-pack/-/tree/main/content/Bijection-from-Images) for two cards, one to remember the image and one to remember the label in the filename,
* [content/Vocabulary-from-Anki](https://gitlab.phaidra.org/kartenaale/templates/anki-pack/-/tree/main/content/Vocabulary-from-Anki) for vocabulary cards, with an Anki text export of simple notes as the data source.
To get your changes back into the repository and test them, create a new branch
with your changes and open a merge request. Check the APKGs in the CI/CD build
job on the MR and if you are happy, merge to main.
### Releasing a new version
Bump the version number in `package.json` in your merge request.
When your changes land on the main branch, a new release will be created in the
releases section of the project and the kartenaale whatsapp group will be
notified (if you go to the CI/CD job and link with your Whatsapp to send out
the notification - restart the job if necessary).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment