A fork of https://github.com/crosspoint-reader/crosspoint-reader
Update README.md with checkout instructions
Fixes https://github.com/daveallie/crosspoint-reader/issues/1
+12
-1
+12
-1
README.md
+12
-1
README.md
···
32
32
- [x] Saved reading position
33
33
- [ ] File explorer with file picker
34
34
- [x] Basic EPUB picker from root directory
35
-
- [ ] Support nested folders
35
+
- [x] Support nested folders
36
36
- [ ] EPUB picker with cover art
37
37
- [ ] Image support within EPUB
38
38
- [ ] Configurable font, layout, and display options
···
47
47
* Python 3.8+
48
48
* USB-C cable for flashing the ESP32-C3
49
49
* Xteink X4
50
+
51
+
### Checking out the code
52
+
53
+
CrossPoint uses PlatformIO for building and flashing the firmware. To get started, clone the repository:
54
+
55
+
```
56
+
git clone --recursive https://github.com/daveallie/crosspoint-reader
57
+
58
+
# Or, if you've already cloned without --recursive:
59
+
git submodule update --init --recursive
60
+
```
50
61
51
62
### Flashing your device
52
63