Skip to content

Commit

Permalink
docs: add page for getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
BrewingWeasel authored Aug 26, 2024
1 parent 5459587 commit 07ebfa7
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Getting Started

When you first launch the app, you will be greeted with the following screen:
![getting_started](https://github.com/user-attachments/assets/0331ee30-910c-4210-ba95-aa8915d472ee)

Your first step is to choose a starter template for your first [profile](profiles.md)
![starter_template](https://github.com/user-attachments/assets/4295938c-3ecb-429a-a659-cd4bad3ae8a6)

If your target language doesn't have an existing template, you can simply click custom and set it up later in "Setting up a new language".
You can also make an issue and I will try to add that language at some later point.

From there, if you are planning on using Anki, you can set up your Word Knowledge deck sources by clicking on the plus.
If you see "Anki is not available", you may need to open Anki or make sure that AnkiConnect is actually installed.
You can hit the refresh button to make sure it is set up.
See [Word Knowledge](word_knowledge.md) and [Word Knowledge Settings](word_knowledge_settings.md#Anki) for information on how to properly configure this.

![20240825_20h20m40s_grim](https://github.com/user-attachments/assets/04b4711f-1cb9-42fa-836a-791a7da42b79)
Installing and setting up stanza is generally recommended. See [Stanza](stanza.md) for details on when you would want to set it up.

Congrats! You just did the main set up for Kalba.
If you are using the "custom" template to set up a new language, check out [Setting up a new language](new_language.md).
Otherwise, you can jump directly to [Next Steps](next_steps.md).

0 comments on commit 07ebfa7

Please sign in to comment.