Update user guide
Some checks are pending
CI / build (push) Waiting to run

This commit is contained in:
Dave Allie 2025-12-20 01:44:39 +11:00
parent 7484fe478c
commit cfe838e03b
No known key found for this signature in database
GPG Key ID: F2FDDB3AD8D0276F
2 changed files with 42 additions and 13 deletions

View File

@ -23,18 +23,23 @@ CrossPoint Reader aims to:
This project is **not affiliated with Xteink**; it's built as a community project. This project is **not affiliated with Xteink**; it's built as a community project.
## Features ## Features & Usage
- [x] EPUB parsing and rendering - [x] EPUB parsing and rendering
- [ ] Image support within EPUB
- [x] Saved reading position - [x] Saved reading position
- [ ] File explorer with file picker - [x] File explorer with file picker
- [x] Basic EPUB picker from root directory - [x] Basic EPUB picker from root directory
- [x] Support nested folders - [x] Support nested folders
- [ ] EPUB picker with cover art - [ ] EPUB picker with cover art
- [ ] Image support within EPUB - [x] Custom sleep screen
- [ ] Cover sleep screen
- [x] Wifi book upload
- [ ] Wifi OTA updates
- [ ] Configurable font, layout, and display options - [ ] Configurable font, layout, and display options
- [ ] WiFi connectivity - [ ] Screen rotation
- [ ] BLE connectivity
See [the user guide](./USER_GUIDE.md) for instructions on operating CrossPoint.
## Installing ## Installing
@ -59,10 +64,6 @@ back to the other partition using the "Swap boot partition" button here https://
See [Development](#development) below. See [Development](#development) below.
## Usage
See [the user guide](./USER_GUIDE.md) for instructions on operating CrossPoint.
## Development ## Development
### Prerequisites ### Prerequisites

View File

@ -19,24 +19,51 @@ The device utilises the standard buttons on the Xtink X4 in the same layout:
### Power On / Off ### Power On / Off
To turn the device on or off, **press and hold the Power button for 1 full second**. To turn the device on or off, **press and hold the Power button for half a second**. In **Settings** you can configure
the power button to trigger on a short press instead of a long one.
### First Launch ### First Launch
Upon turning the device on for the first time, you will be placed on the **Book Selection Screen** (File Browser). Upon turning the device on for the first time, you will be placed on the **Home** screen.
> **Note:** On subsequent restarts, the firmware will automatically reopen the last book you were reading. > **Note:** On subsequent restarts, the firmware will automatically reopen the last book you were reading.
--- ---
## 3. Book Selection ## 3. Screens
The Home Screen acts as a folder and file browser. ### 3.1 Home Screen
The Home Screen is the main entry point to the firmware. From here you can navigate to the **Book Selection** screen,
**Settings** screen, or **File Upload** screen.
### 3.2 Book Selection (Read)
The Book Selection acts as a folder and file browser.
* **Navigate List:** Use **Left** (or **Volume Up**), or **Right** (or **Volume Down**) to move the selection cursor up * **Navigate List:** Use **Left** (or **Volume Up**), or **Right** (or **Volume Down**) to move the selection cursor up
and down through folders and books. and down through folders and books.
* **Open Selection:** Press **Confirm** to open a folder or read a selected book. * **Open Selection:** Press **Confirm** to open a folder or read a selected book.
### 3.3 Reading Screen
See [4. Reading Mode](#4-reading-mode) below for more information.
### 3.4 File Upload Screen
The File Upload screen allows you to upload new e-books to the device. When you enter the screen you'll be prompted with
a WiFi selection dialog and then your X4 will start hosting a web server.
See the [webserver docs](./docs/webserver.md) for more information on how to connect to the web server and upload files.
### 3.5 Settings
The Settings screen allows you to configure the device's behavior. There are a few settings you can adjust:
- **White Sleep Screen**: Whether to use the white screen or black (inverted) default sleep screen
- **Extra Paragraph Spacing**: If enabled, vertical space will be added between paragraphs in the book, if disabled,
paragraphs will not have vertical space between them, but will have first word indentation.
- **Short Power Button Click**: Whether to trigger the power button on a short press or a long press.
--- ---
## 4. Reading Mode ## 4. Reading Mode
@ -76,3 +103,4 @@ are planned for future updates:
* **Images:** Embedded images in e-books will not render. * **Images:** Embedded images in e-books will not render.
* **Text Formatting:** There are currently no settings to adjust font type, size, line spacing, or margins. * **Text Formatting:** There are currently no settings to adjust font type, size, line spacing, or margins.
* **Rotation**: Different rotation options are not supported.