From d06b121a1f45dcbf2cd3e76b8c110466aaa6408b Mon Sep 17 00:00:00 2001 From: Philipp Stadler <hello@phstadler.com> Date: Thu, 18 Jul 2024 21:40:52 +0200 Subject: [PATCH] docs: document how to contribute --- GUIDE.md | 2 +- README.md | 17 +++++++++++++---- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/GUIDE.md b/GUIDE.md index f9b265f..a3e2d9f 100644 --- a/GUIDE.md +++ b/GUIDE.md @@ -33,7 +33,7 @@ Some features: * touch a character to see stroke order details incl numbering, * add your own notes and automatically get radical and listening exercises in addition to classic vocabulary cards. -Among other places, the Kartenaale group meets on [Whatsapp](https://chat.whatsapp.com/JFKpfmq29yM2xKcSu7JQib) +Among other places, the Kartenaale group meets on [Whatsapp](https://chat.whatsapp.com/JFKpfmq29yM2xKcSu7JQib). ## Quickstart Guide diff --git a/README.md b/README.md index da9f0be..58eaf32 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,18 @@ # Getting started with Anki -Hi, if you are wondering how to start using Anki with kartenaale content, then -this page is for you. +Hi, if you are wondering how to start using Anki with _Kartenaale_ content, +then this page is for you. If you are completely new to Anki, see the user guide in [English](GUIDE.md) or [German](ANLEITUNG.md). -If you already know Anki and just want to download APKGs, check out the release sections in the various -packs in [kartenaale/packs](https://gitlab.phaidra.org/kartenaale/packs), e.g. [Sinologie Anki Decks STEOP](https://gitlab.phaidra.org/kartenaale/packs/sinology-1/-/releases) for STEOP. +If you already know Anki and just want to download APKGs, check out the release +sections in the various packs in +[kartenaale/packs](https://gitlab.phaidra.org/kartenaale/packs), e.g. +[Sinologie Anki Decks STEOP](https://gitlab.phaidra.org/kartenaale/packs/sinology-1/-/releases) +for STEOP. + +If you want to contribute your own Anki content, either contribute to an +existing pack with a merge request or check out the starter project +in +[kartenaale/templates/anki-pack](https://gitlab.phaidra.org/kartenaale/templates/anki-pack) +to start your own new pack. -- GitLab