csv2apkg readme

zhaisilong · Oct 6, 2024 · 3e3697d · 3e3697d
1 parent 16536bb
commit 3e3697d
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,25 @@ program. Please see below for concepts and usage.
 
 [![CI](https://github.com/kerrickstaley/genanki/actions/workflows/ci.yml/badge.svg)](https://github.com/kerrickstaley/genanki/actions/workflows/ci.yml)
 
+## Pro version
+
+### Setup
+
+```bash
+git clone [email protected]:zhaisilong/genanki.git
+
+cd genanki
+pip install -e .
+```
+
+### CSV to APKG
+
+```bash
+csv2apkg -h
+csv2apkg test_single.csv  --mode=single  # with single col csv without header
+csv2apkg test.csv  # csv with question and answer as header
+```
+
 ## Notes
 The basic unit in Anki is the `Note`, which contains a fact to memorize. `Note`s correspond to one or more `Card`s.
 

diff --git a/genanki.md b/genanki.md
@@ -1,12 +1 @@
-# Anki
 
-## genanki: A Library for Generating Anki Decks
-
-```bash
-git clone [email protected]:zhaisilong/genanki.git
-
-cd genanki
-pip install -e .
-
-csv2apkg test.csv
-```