snark13/Xteink-X4-crosspoint-reader
1
0
Fork 0
mirror of https://github.com/daveallie/crosspoint-reader.git synced 2025-12-16 22:27:42 +03:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update README.md with checkout instructions

Browse Source 
Fixes https://github.com/daveallie/crosspoint-reader/issues/1
This commit is contained in:
Dave Allie 2025-12-06 04:53:58 +11:00
parent 8679c8f57c
commit f0d92da8f2
No known key found for this signature in database
GPG Key ID: F2FDDB3AD8D0276F
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -32,7 +32,7 @@ This project is **not affiliated with Xteink**; it's built as a community projec
- [x] Saved reading position
- [ ] File explorer with file picker
- [x] Basic EPUB picker from root directory
- [ ] Support nested folders
- [x] Support nested folders
- [ ] EPUB picker with cover art
- [ ] Image support within EPUB
- [ ] Configurable font, layout, and display options
@ -48,6 +48,17 @@ This project is **not affiliated with Xteink**; it's built as a community projec
* USB-C cable for flashing the ESP32-C3
* Xteink X4
### Checking out the code
CrossPoint uses PlatformIO for building and flashing the firmware. To get started, clone the repository:
```
git clone --recursive https://github.com/daveallie/crosspoint-reader
# Or, if you've already cloned without --recursive:
git submodule update --init --recursive
```
### Flashing your device
#### Command line