A fork of https://github.com/crosspoint-reader/crosspoint-reader
This is a fork
+8
-6
+8
-6
README.md
+8
-6
README.md
···
1
-
# CrossPoint Reader
1
+
# CrossPoint Reader Fork
2
+
3
+
**This repository is a fork of https://github.com/crosspoint-reader/crosspoint-reader**
2
4
3
5
Firmware for the **Xteink X4** e-paper display reader (unaffiliated with Xteink).
4
6
Built using **PlatformIO** and targeting the **ESP32-C3** microcontroller.
5
7
6
-
CrossPoint Reader is a purpose-built firmware designed to be a drop-in, fully open-source replacement for the official
8
+
CrossPoint Reader is a purpose-built firmware designed to be a drop-in, fully open-source replacement for the official
7
9
Xteink firmware. It aims to match or improve upon the standard EPUB reading experience.
8
10
9
11
10
12
11
13
## Motivation
12
14
13
-
E-paper devices are fantastic for reading, but most commercially available readers are closed systems with limited
15
+
E-paper devices are fantastic for reading, but most commercially available readers are closed systems with limited
14
16
customisation. The **Xteink X4** is an affordable, e-paper device, however the official firmware remains closed.
15
17
CrossPoint exists partly as a fun side-project and partly to open up the ecosystem and truly unlock the device's
16
18
potential.
···
145
147
146
148
### Data caching
147
149
148
-
The first time chapters of a book are loaded, they are cached to the SD card. Subsequent loads are served from the
150
+
The first time chapters of a book are loaded, they are cached to the SD card. Subsequent loads are served from the
149
151
cache. This cache directory exists at `.crosspoint` on the SD card. The structure is as follows:
150
152
151
153
···
163
165
└── epub_189013891/
164
166
```
165
167
166
-
Deleting the `.crosspoint` directory will clear the entire cache.
168
+
Deleting the `.crosspoint` directory will clear the entire cache.
167
169
168
170
Due the way it's currently implemented, the cache is not automatically cleared when a book is deleted and moving a book
169
171
file will use a new cache directory, resetting the reading progress.
···
179
181
If you're looking for a way to help out, take a look at the [ideas discussion board](https://github.com/crosspoint-reader/crosspoint-reader/discussions/categories/ideas).
180
182
If there's something there you'd like to work on, leave a comment so that we can avoid duplicated effort.
181
183
182
-
Everyone here is a volunteer, so please be respectful and patient. For more details on our governance and community
184
+
Everyone here is a volunteer, so please be respectful and patient. For more details on our governance and community
183
185
principles, please see [GOVERNANCE.md](GOVERNANCE.md).
184
186
185
187
### To submit a contribution: