diff --git a/README.md b/README.md index 5e453ae0b2653fccc145d3e2ace20d8c042e0f24..18ecdda4980186146aa46663c61833920cded357 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # Brand spanking new Anki Pack Hi, do you want to build a new Anki pack? You can start with this repository! +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) @@ -19,13 +24,23 @@ _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). -## Importing the pack to your phone -Open the [releases section](-/releases) and click _Browse all APKGS…_. There, -click an APKG, download it, and import into Anki. +*Everything below this point is not starter-project-specific, you may want to keep it* + +## Importing the pack to your phone or PC +Open the [releases section](-/releases) and 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 +[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, add subfolders to `content/` with a -`.apkg-spec.yaml` file in it, and data in the form of CSV, images or APKGs. +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 too 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: @@ -37,9 +52,9 @@ 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` and merge the pull request. +Bump the version number in `package.json` in your merge request. -A new release will be created in the [releases section](-/releases) 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). +When your changes land on the main branch, a new release will be created in the +[releases section](-/releases) 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). diff --git a/package.json b/package.json index 048ef716513a9a131f0e7656e1cf6bdce3a8b3bc..1fe40bb8d1bdb646910f23cead9329033e3fd09d 100644 --- a/package.json +++ b/package.json @@ -1,3 +1,3 @@ { - "version": "1.0.0-starter2" + "version": "1.0.0-starter3" }