summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob L. Kreuze <zerodaysfordays@sdf.org>2025-11-26 15:32:10 -0500
committerJakob L. Kreuze <zerodaysfordays@sdf.org>2025-11-26 15:32:10 -0500
commit5d38e8c780a38a3344c43be4fff5c717fcf8a736 (patch)
treee7598e8713609eada38d2d84479d545dabc13795 /README.md
parent5dd9489868d24140d4006cc80edf3a3e16de8290 (diff)
Document deck editor
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 043d1c7..d048e0b 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,12 @@ The "?" button will display the available keyboard shortcuts.
When the review is complete, you will be prompted to download a JSON file.
This contains the deck of cards updated with new scheduling parameters for your next review.
+SRS Anywhere comes with a simple editor for adding, editing, and removing cards from a deck.
+Open `deck-editor.html` and press the "Browse..." button in the top right-hand corner to load a deck of cards.
+The page will populate with one or more tables, each corresponding to a specific type of card, and input fields for part of the card.
+The button labeled with a plus sign (+) will add a card of that type to the deck, with an automatically-generated ID.
+Press the "Download JSON" button in the top right-hand corner to download the modified deck.
+
### Format for Cards
The `cards.json` file is an array of objects containing at least the keys `id`, `front`, and `back`.