Quickstart.md

Quickstart

This guide assumes you already have an account and can sign in.

Path 1: Create a deck and a card

  1. Go to Decks (/decks)

  2. Create a new deck

  3. Open that deck

  4. In “Add a card”, choose Format (Markdown or LaTeX. If unsure, choose Markdown, it is very easy to learn.)

  5. Fill in:

    • Front: the front of the card, will be shown to you to let you recall the answer

      What is the capital of France?

    • Back: the answer / explanation

      The capital of France is Paris.

  6. Click Create

  7. Click Study (/study) and review the card

Path 2: Create a note and generate cards

  1. Go to Notes (/notes)

  2. Click New note

  3. In “Options”, choose a Format: (if unsure, choose Markdown, it is very easy to learn.)

    • Markdown (for .arms / .md)

    • LaTeX (for .tex)

  4. Fill Path (relative), for example:

    • haskell-tutorial.md

    • math/group-theory.arms

    • biology/cells.md

    • latex/linear-algebra.tex

  5. Write some content (Markdown / LaTeX), and mark it up using ARMS documentation syntax:

    Today we are learning some basic arithmetic, the peano axioms for natural numbers.

<card>
<front>
What is a natural number?
</front>
<back>
**Definition**: A natural number is either $0$ (zero)
or a successor of a natural number $S(n)$.
</back>
</card>

Once the natural number is defined, we can define what addition is.

<card><common>
**Definition**: Addition is defined by the following rules:

- For any natural number n, <cloze>$0 + n = n$</cloze>

- For any <cloze>natural numbers m and n, $S(m) + n = S(m + n)$</cloze>
</common></card>

**Example**.

<card><common>
Let's compute 2 + 2.

$$
\begin{align*}
  2 + 2 & = S(S(0)) + S(S(0)) \\
        & = <cloze>S(S(0) + S(S(0)))</cloze> \\
        & = S(0 + S(S(S(0)))) \\
        & = S(S(S(S(0)))) \\
        & = 4
\end{align*}
$$
</common></card>

  6. Save the note

  7. Click Generate preview

  8. Optional: choose a deck destination

  9. Click Confirm generation

What “Confirm generation” does:

  • inserts stable uuid="..." attributes into your note (so identity persists)
  • upserts cards into the database (create or update by UUID)

Next: