edouard.paris / crosspoint-reader
A fork of https://github.com/crosspoint-reader/crosspoint-reader
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

Update User Guide to reflect release 0.13.1 (#337)

Please note I have not tested the Calibre features and am not yet in a
position to offer detailed documentation of how they work.

authored by

Luke Stein and committed by
GitHub c2fb8ce5 ed05554d

+24 -8
+24 -8
USER_GUIDE.md
··· 20 20 21 21 ### Power On / Off 22 22 23 - To turn the device on or off, **press and hold the Power button for half a second**. In **[Settings](#35-settings)** you can configure the power button to trigger on a short press instead of a long one. 23 + To turn the device on or off, **press and hold the Power button for approximately half a second**. 24 + In **[Settings](#35-settings)** you can configure the power button to turn the device off with a short press instead of a long one. 24 25 25 - To reboot the device (for example if it's frozen, or after a firmware update), press and release the Reset button, and then hold the Power button for a few seconds. 26 + To reboot the device (for example if it's frozen, or after a firmware update), press and release the Reset button, and then quickly press and hold the Power button for a few seconds. 26 27 27 28 ### First Launch 28 29 ··· 63 64 64 65 The Settings screen allows you to configure the device's behavior. There are a few settings you can adjust: 65 66 - **Sleep Screen**: Which sleep screen to display when the device sleeps: 66 - - "Dark" (default) - The default dark sleep screen 67 + - "Dark" (default) - The default dark Crosspoint logo sleep screen 67 68 - "Light" - The same default sleep screen, on a white background 68 - - "Custom" - Custom images from the SD card, see [Sleep Screen](#36-sleep-screen) below for more information 69 + - "Custom" - Custom images from the SD card; see [Sleep Screen](#36-sleep-screen) below for more information 69 70 - "Cover" - The book cover image (Note: this is experimental and may not work as expected) 70 - - "Blank" - A blank screen 71 + - "None" - A blank screen 72 + - **Sleep Screen Cover Mode**: How to display the book cover when "Cover" sleep screen is selected: 73 + - "Fit" (default) - Scale the image down to fit centered on the screen, padding with white borders as necessary 74 + - "Crop" - Scale the image down and crop as necessary to try to to fill the screen (Note: this is experimental and may not work as expected) 71 75 - **Status Bar**: Configure the status bar displayed while reading: 72 76 - "None" - No status bar 73 77 - "No Progress" - Show status bar without reading progress 74 78 - "Full" - Show status bar with reading progress 79 + - **Hide Battery %**: Configure where to suppress the battery pecentage display in the status bar; the battery icon will still be shown: 80 + - "Never" - Always show battery percentage (default) 81 + - "In Reader" - Show battery percentage everywhere except in reading mode 82 + - "Always" - Always hide battery percentage 75 83 - **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-line indentation. 76 - - **Short Power Button Click**: Whether to trigger the power button on a short press or a long press. 77 - - **Reading Orientation**: Set the screen orientation for reading: 84 + - **Text Anti-Aliasing**: Whether to show smooth grey edges (anti-aliasing) on text in reading mode. Note this slows down page turns slightly. 85 + - **Short Power Button Click**: Controls the effect of a short click of the power button: 86 + - "Ignore" - Require a long press to turn off the device 87 + - "Sleep" - A short press powers the device off 88 + - "Page Turn" - A short press in reading mode turns to the next page; a long press turns the device off 89 + - **Reading Orientation**: Set the screen orientation for reading EPUB files: 78 90 - "Portrait" (default) - Standard portrait orientation 79 91 - "Landscape CW" - Landscape, rotated clockwise 80 92 - "Inverted" - Portrait, upside down ··· 83 95 - Back, Confirm, Left, Right (default) 84 96 - Left, Right, Back, Confirm 85 97 - Left, Back, Confirm, Right 86 - - **Side Button Layout**: Swap the order of the up and down volume buttons from Previous/Next to Next/Previous. This change is only in effect when reading. 98 + - **Side Button Layout (reader)**: Swap the order of the up and down volume buttons from Previous/Next to Next/Previous. This change is only in effect when reading. 87 99 - **Reader Font Family**: Choose the font used for reading: 88 100 - "Bookerly" (default) - Amazon's reading font 89 101 - "Noto Sans" - Google's sans-serif font 90 102 - "Open Dyslexic" - Font designed for readers with dyslexia 91 103 - **Reader Font Size**: Adjust the text size for reading; options are "Small", "Medium", "Large", or "X Large". 92 104 - **Reader Line Spacing**: Adjust the spacing between lines; options are "Tight", "Normal", or "Wide". 105 + - **Reader Screen Margin**: Controls the screen margins in reader mode between 5 and 40 pixels in 5 pixel increments. 93 106 - **Reader Paragraph Alignment**: Set the alignment of paragraphs; options are "Justified" (default), "Left", "Center", or "Right". 94 107 - **Time to Sleep**: Set the duration of inactivity before the device automatically goes to sleep. 95 108 - **Refresh Frequency**: Set how often the screen does a full refresh while reading to reduce ghosting. 109 + - **Calibre Settings**: Set up integration for accessing a Calibre web library or connecting to Calibre as a wireless device. 96 110 - **Check for updates**: Check for firmware updates over WiFi. 97 111 98 112 ### 3.6 Sleep Screen ··· 123 137 | **Next Page** | Press **Right** _or_ **Volume Down** | 124 138 125 139 The role of the volume (side) buttons can be swapped in **[Settings](#35-settings)**. 140 + 141 + If the **Short Power Button Click** setting is set to "Page Turn", you can also turn to the next page by briefly pressing the Power button. 126 142 127 143 ### Chapter Navigation 128 144 * **Next Chapter:** Press and **hold** the **Right** (or **Volume Down**) button briefly, then release.