Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ttu-ttu committed Aug 28, 2021
1 parent a96d47e commit f96702c
Show file tree
Hide file tree
Showing 17 changed files with 98 additions and 63 deletions.
113 changes: 50 additions & 63 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,66 @@
<img src="assets/readme/icon.png" align="left" style="margin-right: 1rem;">
<img src="assets/readme/icon.png" align="left" style="margin-right: 1rem;" alt="">

## ッツ Ebook Reader

Source code for the Website [https://ttu-ebook.web.app](https://ttu-ebook.web.app), an online e-book reader that supports Yomichan.
<p style="margin-bottom: 3rem;"/>
An online e-book reader that supports Yomichan, which is hosted on [https://ttu-ebook.web.app](https://ttu-ebook.web.app)

# Features

- [x] Supports HTMLZ and EPUB Files
- [x] Vertical Reading Style
- [x] Local Book Library
- [x] Automatic load of the last opened Book
- [x] Auto Scrolling
- [x] Book Manager
- [x] Experience Settings (e. g. Themes, Font Size, Image Blur, Furigana Settings)
- [x] Bookmark Functionality
- [x] Current Character and Progress Display
- [x] Installable as Application on supported Platforms / Browsers
- [x] Supports HTMLZ and EPUB files
- [x] Vertical reading style
- [x] Local book library
- [x] Auto scroll
- [x] Book manager
- [x] Customizable environment (e. g. themes, font size, image blur, furigana Settings)
- [x] Bookmark functionality
- [x] Character count and progress display

# Usage:
# Usage

The first Time you enter the Page (or have no Files loaded yet) you need to select the Books you want to read from your Device.
You can load a Single File by clicking/tapping on the Dropzone or select a whole Folder (Desktop only) with right click.
Alternatively simply drag&drop Files and Folders on the Element in case you are a Desktop User.
The first time you enter the page (or have no files loaded yet) you will need to select the books you want to read from your device.
You can load on file by clicking/tapping on the dropzone, or load on folder (desktop only) by right click.
Alternatively, you can also drag & drop files or folders on the reader if your device supports it.

If you imported a single File this Title will be automatically be loaded into the Reader. In case of multiple Files the Manager
View will be opened on which you can decide which Book you want to open in the Reader. On your next Visit the Page will
automatically load the last Book you have read.
You may find the following controls in the reader:

You can find following Control Elements in the Reader:

Element | Description
Control | Description
--- | ---
<img src="assets/readme/control_fs.PNG"> | Allows you enter the Fullscreen Mode (Keybind F11)
<img src="assets/readme/control_file.png"> | Allows you to import new Books to your Library
<img src="assets/readme/control_folder.png"> | Allows you to import new Books from a Folder to your Library (Desktop Only)
<img src="assets/readme/control_manager.png"> | Opens the Book Manager (Keybind m)
<img src="assets/readme/control_bm.png"> | Allows you to set a Bookmark at your current Location (Keybind b)
<img src="assets/readme/control_settings.png"> | Opens the Reader Settings

In the bottom right corner you will be able to see your current Reading Progress. <img src="assets/readme/progress.png" style="margin-left: 1rem">

You can toggle the visibility by clicking/tapping on it.

<p style="margin-bottom: 3rem;">An Update to the Page is indicated by the <img src="assets/readme/update.png" style="margin: 0rem 1rem;">
Symbol in the bottom left corner. After the next Page reload it will automatically be applied in case you are connected with the Internet.</p>

# Desktop Keybinds:

**Note:** The Keys are currencly bound to their Physical Location.
![Icon](assets/readme/control-fullscreen.svg) | Allows you to enter fullscreen mode
![Icon](assets/readme/control-file-upload.svg) | Allows you to import new books to the library
![Icon](assets/readme/control-folder-upload.svg) | Allows you to import new books from a folder to the library (desktop only)
![Icon](assets/readme/control-manager.svg) | Opens book manager (keybind <kbd>M</kbd>)
![Icon](assets/readme/control-bookmark.svg) | Allows you to create a bookmark at your current location (keybind <kbd>B</kbd>)
![Icon](assets/readme/control-settings.svg) | Prompts settings dialog
![Image](assets/readme/book-progress.png) | Displays your reading progress, click/tap on it to hide
![Image](assets/readme/control-update.svg) | Indicates an update is available for the reader, and will be loaded on next refresh

# Desktop Keybinds

**Note:** The keys are currently bound to their physical location.
Explanation from [MDN](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code):

> For example, the code returned is "KeyQ" for the Q key on a QWERTY layout keyboard, but the same code value also
represents the ' key on Dvorak keyboards and the A key on AZERTY keyboards.
> For example, the code returned is "KeyQ" for the Q key on a QWERTY layout keyboard, but the same code value also
represents the ' key on Dvorak keyboards and the A key on AZERTY keyboards.

Key Code | Description
--- | ---
<kbd>Escape</kbd> | Close Settings Dialog
<kbd>Space</kbd> | Toggle Auto-Scrolling
<kbd>a</kbd> / <kbd>d</kbd> | Increase / Decrease Auto-Scrolling Speed
<kbd>b</kbd> | Create Bookmark at your current Location
<kbd>m</kbd> | Open Book Manager
<kbd>PageDown</kbd> / <kbd>PageUp</kbd> | Turn Pages

# Book Manager:

You can open the Book Manager by clicking/tapping on the respective Icon or pressing its Keybind (m) as Desktop User.
You will be presented with a List of Covers of all your imported Books and their respective Titles and Progress (available
after re-setting a Bookmark). The current opened Book will be highlighted with a red glowing Border.
To change your current Book you can click/tap on the Book Cover or Title.

You can delete Books by clicking/tapping on their respective Checkbox and the trash can icon. After you confirmed the Deletion
all Data and respective Bookmarks will be removed from your Library. In Case you deleted the current opened Book you need to leave
the Manager by clicking on the Book you want to open next. Otherwise you can use the regular Exit Icon to reload the Reader Page.


In order to quickly select all Books you can click/tap on the centered List Icon. Vice Versa clicking/tapping on the X Icon
will deselect all Books.
<kbd>Escape</kbd> | Close settings dialog
<kbd>Space</kbd> | Toggle auto-scroll
<kbd>A</kbd> | Increase auto-scroll speed
<kbd>D</kbd> | Decrease auto-scroll speed
<kbd>B</kbd> | Create bookmark at your current location
<kbd>M</kbd> | Open book manager
<kbd>PageDown</kbd> | Move to next page
<kbd>PageUp</kbd> | Move to previous page

# Book Manager

You can open the book manager by clicking/tapping on the respective icon or the keybinding <kbd>M</kbd> as a desktop user.
You will be presented with a list of covers for all the imported books with their respective titles and progress (determined
by bookmark location). The book currently opened will be highlighted with a red glowing border.

You may:
- Switch books by clicking/tapping on the book covers
- Delete books by clicking/tapping on their respective checkbox and trash can icon (**Warning:** Bookmark progress will also get removed along with the book)
- Click/tap on the centered list icon to select all books
- Click/tap on the X icon to deselect all books
Binary file added assets/readme/book-progress.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions assets/readme/control-bookmark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions assets/readme/control-file-upload.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions assets/readme/control-folder-upload.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions assets/readme/control-fullscreen.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions assets/readme/control-manager.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions assets/readme/control-settings.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions assets/readme/control-update.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/readme/control_bm.png
Binary file not shown.
Binary file removed assets/readme/control_file.png
Binary file not shown.
Binary file removed assets/readme/control_folder.png
Binary file not shown.
Binary file removed assets/readme/control_fs.PNG
Binary file not shown.
Binary file removed assets/readme/control_manager.png
Binary file not shown.
Binary file removed assets/readme/control_settings.png
Binary file not shown.
Binary file removed assets/readme/progress.png
Binary file not shown.
Binary file removed assets/readme/update.png
Binary file not shown.

0 comments on commit f96702c

Please sign in to comment.