Add manual

doc/MANUAL.md

@@ -0,0 +1,120 @@
+# Home
+
+## Summary
+
+- Tap to select/de-select a category.
+- Swipe north to negate/un-negate a category.
+- Swipe south from the inside to the outside of the bar to grow it.
+- Swipe north from the outside to the inside of the bar to shrink it.
+- Swipe west/east to go to the next/previous page.
+
+## Shelf
+
+- Swipe west/east to go to the next/previous page.
+- Tap on a book entry to open it.
+
+# Reader
+
+## Viewer
+
+The screen is divided into three regions:
+
+ ┌─────────┬─────────┬─────────┐
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ P │ B │ N │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ └─────────┴─────────┴─────────┘
+
+Gestures by region:
+
+- *P*:
+ - tap: previous page.
+ - hold: previous chapter.
+- *B*:
+ - tap: toggle the top and bottom bars.
+ - hold: take screenshot.
+- *N*:
+ - tap: next page.
+ - hold: next chapter.
+
+Swipe west/east to go to the next/previous page.
+
+## Bottom bar
+
+Hold the next/previous page icon to go the next/previous chapter.
+
+# Home & Reader
+
+## Menus
+
+You can select a menu entry *without closing the menu* by holding it.
+
+## Top bar
+
+The frontlight can be toggled by holding the frontlight icon.
+
+## Bottom bar
+
+Tap the page indicator to go a specific page.
+
+## Keyboard
+
+The *ALT* and *SHIFT* keys can be locked by tapping them twice.
+
+The *CMB* (combine) key can be used to enter special characters, e.g.: `CMB o e` produces `œ`.
+
+A hold on the delete or motion keys will act on words instead of characters.
+
+# Annex
+
+## Combination Sequences
+
+ o e œ a ` à u " ű ] ] ⟧
+ O e Œ e ` è o " ő + - ±
+ a e æ i ` ì U " Ű - : ÷
+ A E Æ o ` ò O " Ő < = ≤
+ c , ç u ` ù z . ż > = ≥
+ C , Ç A ` À Z . Ż = / ≠
+ a ; ą E ` È t h þ - , ¬
+ e ; ę I ` Ì T h Þ ~ ~ ≈
+ A ; Ą O ` Ò a o å < < «
+ E ; Ę U ` Ù A o Å > > »
+ a ~ ã a ^ â l / ł 1 2 ½
+ o ~ õ e ^ ê d / đ 1 3 ⅓
+ n ~ ñ i ^ î o / ø 2 3 ⅔
+ A ~ Ã o ^ ô L / Ł 1 4 ¼
+ O ~ Õ u ^ û D / Đ 3 4 ¾
+ N ~ Ñ w ^ ŵ O / Ø 1 5 ⅕
+ a ' á y ^ ŷ m u µ 2 5 ⅖
+ e ' é A ^ Â l - £ 3 5 ⅗
+ i ' í E ^ Ê p p ¶ 4 5 ⅘
+ o ' ó I ^ Î s o § 1 6 ⅙
+ u ' ú O ^ Ô | - † 5 6 ⅚
+ y ' ý U ^ Û | = ‡ 1 8 ⅛
+ z ' ź W ^ Ŵ s s ß 3 8 ⅜
+ s ' ś Y ^ Ŷ S s ẞ 5 8 ⅝
+ c ' ć a : ä o _ º 7 8 ⅞
+ n ' ń e : ë a _ ª # f ♭
+ A ' Á i : ï o o ° # n ♮
+ E ' É o : ö ! ! ¡ # s ♯
+ I ' Í u : ü ? ? ¿ % o ‰
+ O ' Ó y : ÿ . - · e = €
+ U ' Ú A : Ä . = • o r ®
+ Y ' Ý E : Ë . > › o c ©
+ Z ' Ź I : Ï . < ‹ o p ℗
+ S ' Ś O : Ö ' 1 ′ t m ™
+ C ' Ć U : Ü ' 2 ″ 
+ N ' Ń Y : Ÿ [ [ ⟦