eBookReaderSwitch/README.md

69 lines
1.8 KiB
Markdown

# eBookReaderSwitch
This is a project I've recently just started working on again. Currently its using MuPDF as its backend. Currently only most pdf files work.
### Features:
* Saves last page number
* Reads PDF files
* Dark and light mode
* Landscape reading view
* Portrait reading view
### Current State:
* Most PDF files work, and all epub, cbz and xps files I've tested work.
### TODO:
* Do some extra testing on file compatibility.
* 2 pages side by side in landscape.
* Touch screen for going to next page.
* Hardware lock to prevent accidental touches (maybe Vol- ?) (?).
* Save orientation, and dark mode settings.
### Screen Shots:
Dark Mode Help Menu:
<br></br>
<img src="screenshots/darkModeHelp.jpg" width="322" height="178.4">
<br></br>
Dark Mode Landscape Reading (With the Switch horizonal):
<br></br>
<img src="screenshots/darkModeLandscape.jpg" width="512" height="288">
<br></br>
Dark Mode Portrait Reading (With the Switch vertical):
<br></br>
<img src="screenshots/darkModePortrait.jpg" width="285.6" height="408.8">
<br></br>
Dark Mode Book Selection:
<br></br>
<img src="screenshots/darkModeSelection.jpg" width="512" height="288">
<br></br>
Light Mode Landscape Reading:
<br></br>
<img src="screenshots/lightModeLandscape.jpg" width="512" height="288">
### Credit:
* moronigranja - For allowing more file support
* NX-Shell Team - A good amount of the code is from an old version of their application.
### Building
* Release built with [libnx release v.4.1.3](https://github.com/switchbrew/libnx).
* Uses `freetype` and other libs which comes with `switch-portlibs` via `devkitPro pacman`:
```
pacman -S libnx switch-portlibs
```
then run:
```
make mupdf
make
```
to build.
if you don't have twili installed then delete the -ltwili flag on:
```
LIBS: -ltwili
```