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

docs: add information about the pack to README

parent 1fda09af
Branches
Tags
1 merge request!1Feat/hsk
# Brand spanking new Anki Pack
Hi, do you want to build a new Anki pack? You can start with this repository!
# HSK (Hanyu Shuiping Kaoshi)
Vocabulary to prepare for HSK exams.
If you want to learn, not create new content, see 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).
## First-time setup for a new project
Create a
[new project](https://gitlab.phaidra.org/projects/new?namespace_id=2286#import_project)
in the _Anki Packs_ namespace and choose _Repository by URL_ with this repo:
```
https://gitlab.phaidra.org/kartenaale/templates/anki-pack.git
```
This step will also clone this README. You can change it later to remove this
section and tell your users something about your pack instead.
Next, enable Gitlab CI for your project. With this feature, your new content
will produce Anki packages on Merge Requests and on the main branch. To enable,
open _Settings_ in the new Gitlab project and expand
_Visibility, project features, permissions_. _CI/CD_ under _Repository_ should
be _enabled_. Customize Merge Requests and other settings to your liking (
_Pipelines must succeed_ is highly recommended).
The content in the cards has been provided by _Konfuzius Institut Leipzig_.
Automatic translations to traditional characters have been added on top (and
may not be reliable).
*Everything below this point is not starter-project-specific, you may want to keep it*
Vocabulary is available in _English_ for all HSK levels. There is a separate
pack for _German_, which covers HSK1–HSK4.
## 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/hsk/-/releases)
on the left, then click _Browse all APKGS…_ on the newest release. There, click
an 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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment