A fork of https://github.com/crosspoint-reader/crosspoint-reader
Enhance USER_GUIDE with links and clarifications (#185)
Updated USER_GUIDE.md for clarity and added links to sections.
## Summary
* Clarify and improve documentation
authored by
Luke Stein
and committed by
GitHub
40f9ed48
b82e044a
+18
-14
+18
-14
USER_GUIDE.md
+18
-14
USER_GUIDE.md
···
5
5
6
6
## 1. Hardware Overview
7
7
8
-
The device utilises the standard buttons on the Xtink X4 in the same layout:
8
+
The device utilises the standard buttons on the Xtink X4 (in the same layout as the manufacturer firmware, by default):
9
9
10
10
### Button Layout
11
11
| Location | Buttons |
12
12
|-----------------|--------------------------------------------|
13
13
| **Bottom Edge** | **Back**, **Confirm**, **Left**, **Right** |
14
14
| **Right Side** | **Power**, **Volume Up**, **Volume Down** |
15
+
16
+
Button layout can be customized in **[Settings](#35-settings)**.
15
17
16
18
---
17
19
···
19
21
20
22
### Power On / Off
21
23
22
-
To turn the device on or off, **press and hold the Power button for half a second**. In **Settings** you can configure
24
+
To turn the device on or off, **press and hold the Power button for half a second**. In **[Settings](#35-settings)** you can configure
23
25
the power button to trigger on a short press instead of a long one.
24
26
25
27
### First Launch
26
28
27
-
Upon turning the device on for the first time, you will be placed on the **Home** screen.
29
+
Upon turning the device on for the first time, you will be placed on the **[Home](#31-home-screen)** screen.
28
30
29
-
> **Note:** On subsequent restarts, the firmware will automatically reopen the last book you were reading.
31
+
> [!NOTE]
32
+
> On subsequent restarts, the firmware will automatically reopen the last book you were reading.
30
33
31
34
---
32
35
···
34
37
35
38
### 3.1 Home Screen
36
39
37
-
The Home Screen is the main entry point to the firmware. From here you can navigate to the **Book Selection** screen,
38
-
**Settings** screen, or **File Upload** screen.
40
+
The Home Screen is the main entry point to the firmware. From here you can navigate to **[Reading Mode](#4-reading-mode)** with the most recently read book, **[Book Selection](#32-book-selection)**,
41
+
**[Settings](#35-settings)**, or the **[File Upload](#34-file-upload-screen)** screen.
39
42
40
-
### 3.2 Book Selection (Read)
43
+
### 3.2 Book Selection
41
44
42
45
The Book Selection acts as a folder and file browser.
43
46
···
45
48
and down through folders and books.
46
49
* **Open Selection:** Press **Confirm** to open a folder or read a selected book.
47
50
48
-
### 3.3 Reading Screen
51
+
### 3.3 Reading Mode
49
52
50
-
See [4. Reading Mode](#4-reading-mode) below for more information.
53
+
See [Reading Mode](#4-reading-mode) below for more information.
51
54
52
55
### 3.4 File Upload Screen
53
56
54
-
The File Upload screen allows you to upload new e-books to the device. When you enter the screen you'll be prompted with
57
+
The File Upload screen allows you to upload new e-books to the device. When you enter the screen, you'll be prompted with
55
58
a WiFi selection dialog and then your X4 will start hosting a web server.
56
59
57
60
See the [webserver docs](./docs/webserver.md) for more information on how to connect to the web server and upload files.
···
62
65
- **Sleep Screen**: Which sleep screen to display when the device sleeps, options are:
63
66
- "Dark" (default) - The default dark sleep screen
64
67
- "Light" - The same default sleep screen, on a white background
65
-
- "Custom" - Custom images from the SD card, see [3.6 Sleep Screen](#36-sleep-screen) below for more information
68
+
- "Custom" - Custom images from the SD card, see [Sleep Screen](#36-sleep-screen) below for more information
66
69
- "Cover" - The book cover image (Note: this is experimental and may not work as expected)
67
70
- **Status Bar**: Configure the status bar displayed while reading, options are:
68
71
- "None" - No status bar
···
95
98
96
99
- **Single Image:** Place a file named `sleep.bmp` in the root directory.
97
100
- **Multiple Images:** Create a `sleep` directory in the root of the SD card and place any number of `.bmp` images
98
-
inside. If images are found in this directory, they will take priority over the `sleep.png` file, and one will be
101
+
inside. If images are found in this directory, they will take priority over the `sleep.bmp` file, and one will be
99
102
randomly selected each time the device sleeps.
100
103
101
104
> [!NOTE]
···
123
126
* **Previous Chapter:** Press and **hold** the **Left** (or **Volume Up**) button briefly, then release.
124
127
125
128
### System Navigation
126
-
* **Return to Home:** Press **Back** to close the book and return to the Book Selection screen.
127
-
* **Chapter Menu:** Press **Confirm** to open the Table of Contents/Chapter Selection screen.
129
+
* **Return to Book Selection:** Press **Back** to close the book and return to the **[Book Selection](#32-book-selection)** screen.
130
+
* **Return to Home:** Press and hold **Back** to close the book and return to the **[Home](#31-home-screen)** screen.
131
+
* **Chapter Menu:** Press **Confirm** to open the **[Table of Contents/Chapter Selection](#5-chapter-selection-screen)**.
128
132
129
133
---
130
134