Skip to content

Commit 319ba89

Browse files
Update TUTORIAL.md
1 parent fc5267a commit 319ba89

File tree

1 file changed

+45
-24
lines changed

1 file changed

+45
-24
lines changed

documents/TUTORIAL.md

Lines changed: 45 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,42 @@
11
# No Nonsense Notes app tutorial
22

3-
Over time, this app developed to be its own thing, so it can feel disorientating for new users. This
4-
document will explain every unintuitive feature of the app, to turn you into a pro in no time!
5-
This guide is written for the phone layout. The tablet layout is a bit different, it's optimized for
6-
bigger screens.
3+
Over time, this app developed to be its own thing, so it can feel disorienting for new users.
4+
5+
This document will explain every unintuitive feature of the app, to turn you into a pro in no time!
6+
This guide is written for the phone layout. The tablet layout is a bit different.
77

88
## Summary
99

1010
```mermaid
1111
graph TD
1212
A[Main view] -->|swipe right| B(Drawer menu)
1313
B --> C{Choose action}
14-
C -->|1 of 3 lists on top| D[fa:fa-list abstract view]
15-
C -->|long press a list| E[edit dialog]
14+
C -->|1 of 3 lists on top| D[fa:fa-list set an abstract view]
15+
C -->|long press a list| E[edit dialog for note lists]
1616
C -->|press a list| F[show list]
17-
C -->|fa:fa-folder button| G[add list]
17+
C -->|fa:fa-folder folder button| G[add a new list]
1818
1919
A --> H[fa:fa-dots overflow menu]
20-
H --> I[fa:fa-archive archive view]
21-
H --> |clear completed| J[send completed \n notes to archive]
20+
H --> |view archive| I[fa:fa-archive see a list of all deleted notes]
21+
H --> |clear completed| J[send completed notes to archive]
22+
23+
A --> |tap + | K[note detail page]
24+
A --> |tap a note | K
25+
K --> |use the back button or gesture| L[the note is automatically saved]
26+
L --> A
27+
K --> |overflow menu| M[note history]
28+
29+
M --> |drag the line| N[see an old version of the note]
30+
N --> |press DONE| O[restore the old version of the note]
31+
O --> K
32+
33+
K --> |press the checkbox| P[mark the note as completed, for your own convenience]
34+
K --> |press the dropdown menu| Q[choose a due date]
35+
Q --> |X button| R[remove the due date]
36+
37+
K --> |add a reminder| S[a new panel appears, to configure the reminder: date, hour, repeating week days and X to delete it]
38+
39+
2240
2341
%% comment: you should finish this chart
2442
%% https://mermaid.live/ is very helpful
@@ -33,16 +51,16 @@ graph TD
3351

3452
Here you see:
3553

36-
* all your lists: you can swipe left and right to navigate between them
37-
* 2 tasks, ordered by due date: the 2° one is "completed" or "done"
54+
* 3 note lists (Next 5 days, Agenda, Ideas): you can swipe left and right to navigate between them
55+
* 2 tasks, ordered by due date: the 2° one is marked as "completed"
3856
* the due date of each task, in the corner on the right
3957
* you can choose how it is displayed
4058
* a `+` button to create a new note
4159
* a search button to find and open one of your notes
4260
* it supports voice search
4361
* if you type, you get suggestions. click on one to open that note
4462
* the hamburger menu `` which can open the drawer menu on the left
45-
* the 3 dots menu `` which has many options
63+
* the overflow menu `` which has many options
4664
* "Sync" forces an update of the files on the SD card
4765
* archive opens the "deleted tasks page", also called "note archive"
4866
* "clear completed" can delete all tasks marked as completed from the current list only
@@ -54,13 +72,13 @@ Here you see:
5472

5573
Here you see:
5674

57-
* the "folder+" icon on the action bar: press it to create a new list
75+
* the `📁+` icon on the action bar: press it to create a new list
5876
* the "tasks" section, which has 3 views that you can use to quickly see some of your notes
5977
* For example, click "today" to see tasks due today
6078
* hold your finger on one of those 3 items to select it as default view
6179
* it will be always on the left of every other list
62-
* in the 1° photo you saw that I choose "next 5 days" as my default view
63-
* the "lists" section has all the note lists you made
80+
* in the first image you saw "next 5 days" as the default view
81+
* the "lists" section has all the note lists you created
6482
* Since "agenda" has 4 un-checked (incomplete) tasks, you see "4" next to it
6583
* hold your finger on one of those lists to open a popup to edit it
6684

@@ -70,11 +88,13 @@ Here you see:
7088

7189
In this dialog you can:
7290

73-
* choose any name for the list
74-
* They are sorted alphabetically. If you want it to appear first, put a `_`, like "_zebra"
91+
* choose a name for the list
92+
* They are sorted alphabetically
93+
* If you want it to appear first, put a `_`, like "_zebra"
94+
* I name my lists `1 Ideas`, `2 Useless` and `3 Agenda` to get a custom order
7595
* set one list as default
7696
* the app will open on that list
77-
* links you share to this app from your browser will go into this list
97+
* links you share to this app from your web browser will go into this list
7898
* choose how notes are ordered on this list in particular
7999
* "latest updated" shows first the notes that you edited more recently
80100
* "due date" also groups the notes by week, month and year
@@ -102,8 +122,9 @@ Here you can:
102122

103123
Here you can see all our settings. They are laid out linearly. I recommend checking all of them, but
104124
in particular the **notification settings**, where you can customize the behavior of notifications
105-
and bypass some android design flaws to **make reminders appear more reliably**. The **backup**
106-
settings are also very useful: you can save the notes as a json file, and restore them if you
125+
and bypass some android design flaws to **make reminders appear more reliably**.
126+
127+
The **backup** settings are also useful: you can save the notes as a json file, and restore them if you
107128
re-install the app even on another phone.
108129

109130
### The task detail panel
@@ -143,7 +164,7 @@ Here you can:
143164

144165
Here you can:
145166

146-
* drag the indicator to see all previous version of the note. Only the ones that you saved
167+
* drag the indicator to see all previous version of the note (but only the ones that you saved)
147168
* press "cancel" to undo and go back
148169
* find a version you like, press "done", and overwrite the current note with that content
149170

@@ -214,9 +235,9 @@ them by mistake and find it irritating.
214235

215236
### Backups
216237

217-
Since this app can export all the notes as a json file, you can elaborate them on a computer. For
218-
example, the following is a short script that outputs the content of a list as a plain text file
219-
with a list of links:
238+
Since this app can export all the notes as a json file, you can elaborate them on a computer.
239+
240+
The following is a short powershell script that outputs the content of a list as a plain text file with a list of links:
220241

221242
```powershell
222243
$json = Get-Content D:\Desktop\NoNonsenseNotes_Backup.json | ConvertFrom-Json

0 commit comments

Comments
 (0)