Skip to content

Commit 5f37ddd

Browse files
committed
Update README: improve formatting, add Linux build steps, clarify platform-specific instructions
- Enhanced Windows, macOS, and Linux usage guidelines. - Added Linux build information under "How to Use" and updated AppImage creation steps. - Refined tips for monochrome and grayscale font selection.
1 parent 0d9e658 commit 5f37ddd

File tree

3 files changed

+32
-18
lines changed

3 files changed

+32
-18
lines changed

README.md

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,12 @@ E-book to XTC format converter based on Cool Reader and crengine.
1212
The primary purpose of this project is to convert e-books (EPUB, FB2, MOBI, etc.) into bitmap images optimized for ESP32 e-paper display devices such
1313
as [Xteink X4](https://www.xteink.com/products/xteink-x4).
1414

15-
Xteink X4 is based on ESP32-C3 and only has 400KB RAM, making it challenging to render books with good formatting. The converter renders book pages and exports them to custom container formats (XTC/XTCH) containing monochrome or 4-level grayscale images (XTG/XTH).
15+
Xteink X4 is based on ESP32-C3 and only has 400KB RAM, making it challenging to render books with good formatting. The converter renders book pages and exports them to custom container formats (
16+
XTC/XTCH) containing monochrome or 4-level grayscale images (XTG/XTH).
1617

1718
XTC Export dialog supports single file and batch export modes.
1819

19-
<img src="docs/export-single.png" width=50% alt="Single file export dialog"><img src="docs/export-batch.png" width=50% alt="Batch export dialog">
20+
<img src="docs/export-single.png" alt="Single file export dialog">
2021

2122
### Supported Input Formats
2223

@@ -34,32 +35,34 @@ Also check `*.ksy` files in the same folder for [Kaitai Struct](https://kaitai.i
3435

3536
## How to Use
3637

37-
### Windows release builds
38-
39-
Download the latest release version from the [Releases](https://github.com/CrazyCoder/cr2xt/releases) page.
40-
41-
- Unpack and run `crqt.exe`
4238
- File | **Open** and select your e-book file
4339
- File | **Settings** (F9) to access formatting and font settings (or Settings from the context menu)
40+
- View | **Rotate** (Ctrl+R) to change orientation (portrait or landscape)
4441
- File | **Export** (Ctrl+S) to open the export dialog (or use Export from the context menu)
4542

4643
Export preview supports mouse wheel scrolling and zooming (with Ctrl+Mouse Wheel). Double-click to reset zoom.
4744

45+
### Windows release builds
46+
47+
Download the latest release version from the [Releases](https://github.com/CrazyCoder/cr2xt/releases) page.
48+
49+
- Unpack and run `crqt.exe`
50+
4851
### macOS release builds
4952

50-
Download the DMG from the [Releases](https://github.com/CrazyCoder/cr2xt/releases) page.
53+
Download the DMG from the [Releases](https://github.com/CrazyCoder/cr2xt/releases) page. macOS 26+ is required.
5154

5255
**Important:** The app is ad-hoc signed (not notarized by Apple). macOS Gatekeeper will block it on first run. To open:
5356

5457
1. **Option A** - Right-click method:
55-
- Right-click (or Control-click) on `cr2xt.app`
56-
- Select **Open** from the context menu
57-
- Click **Open** in the dialog that appears
58+
- Right-click (or Control-click) on `cr2xt.app`
59+
- Select **Open** from the context menu
60+
- Click **Open** in the dialog that appears
5861

5962
2. **Option B** - System Settings:
60-
- Try to open the app normally (it will be blocked)
61-
- Go to **System Settings****Privacy & Security**
62-
- Scroll down and click **Open Anyway** next to the cr2xt message
63+
- Try to open the app normally (it will be blocked)
64+
- Go to **System Settings****Privacy & Security**
65+
- Scroll down and click **Open Anyway** next to the cr2xt message
6366

6467
3. **Option C** - Terminal (removes quarantine flag):
6568
```bash
@@ -68,19 +71,25 @@ Download the DMG from the [Releases](https://github.com/CrazyCoder/cr2xt/release
6871

6972
After allowing once, the app will open normally.
7073

71-
Stock firmware renders 2-bit grayscale images too slowly, it's recommended to use 1-bit monochrome mode.
74+
### Linux release builds
75+
76+
Use the AppImage package from the Releases page. It includes all dependencies and should work on most modern Linux distributions.
77+
78+
7279

7380
### Tips
7481

75-
- Try to find a font that looks best without antialiasing (Verdana, Tahoma, Roboto, old fonts with good hinting)
82+
- Stock English firmware renders 2-bit grayscale images too slowly, it's recommended to use 1-bit monochrome mode.
83+
It has been improved in CN firmware, and it works faster in [CrossPoint](https://github.com/daveallie/crosspoint-reader/) custom firmware
84+
- For 1-bit mode, try to find a font that looks best without antialiasing (Verdana, Tahoma, Roboto, old fonts with good hinting)
85+
- For 2-bit mode, make sure to enable antialiasing in Settings | Styles and use Font gamma to control contrast
7686
- Play with the font size / weight and avoid synthetic weights (Roboto family supports all weights natively)
7787
- Some fonts work better with Autohinting (Roboto), others work better with Bytecode (Verdana)
7888
- Adjust page margins and interline spacing to fit as many lines as possible but so that it's still comfortable to read
7989
- Disable page number / page counter and other text in the header to save vertical space
8090
- Further adjust header navigation bar margins for minimal look
8191
- Use Settings | Stylesheet to adjust element margins and justification
8292
- For advanced users, enable "Use expanded CSS file" and edit the `<format>-expanded.css` file, changes will be applied on the fly
83-
- View | **Rotate** (Ctrl+R) to change orientation (portrait or landscape)
8493

8594
### Export Dialog Features
8695

@@ -121,7 +130,7 @@ This project is a **converter-focused fork** with several key differences:
121130
- [ ] cr2xt CLI converter
122131
- [ ] Docker image with CLI converter
123132
- [x] macOS builds
124-
- [ ] Linux builds
133+
- [x] Linux builds
125134
- [ ] Unofficial compression for XTC format to be used in custom firmwares
126135
- [ ] New custom XTB format with compression
127136

@@ -194,6 +203,8 @@ cmake --build build/release --target install
194203

195204
**Linux:**
196205

206+
Use `scripts/create-appimage.sh` or manually run the following commands:
207+
197208
```bash
198209
cmake -B build/release \
199210
-DCMAKE_BUILD_TYPE=Release \
@@ -204,6 +215,9 @@ cmake -B build/release \
204215
cmake --build build/release -j$(nproc)
205216
```
206217

218+
You will need to install dependencies for crengine.
219+
220+
207221
## License
208222

209223
This project inherits the licenses from its upstream components:

docs/export-batch.png

47.1 KB
Loading

docs/export-single.png

3.63 KB
Loading

0 commit comments

Comments
 (0)