107 lines
2.7 KiB
Markdown
107 lines
2.7 KiB
Markdown
|
||
|
||
|
||
|
||
Treader is an e-book reader for Android devices;
|
||
it supports the following formats: PDF, EPUB, EPUB3, MOBI, DjVu, FB2, TXT, RTF, AZW, AZW3, HTML, CBZ, CBR, DOC, DOCX,
|
||
and OPDS Catalogs
|
||
|
||
|
||
## Required build libs
|
||
|
||
~~~~
|
||
mesa-common-dev libxcursor-dev libxrandr-dev libxinerama-dev libglu1-mesa-dev libxi-dev pkg-config libgl-dev
|
||
~~~~
|
||
|
||
You also need the Android NDK in version 20+
|
||
Please ensure to download it using android studio and add the NDK to your PATH.
|
||
|
||
## Create a keystore
|
||
|
||
Even if you do not plan to upload a version yourself you need a keystore with a certificate to build.
|
||
The keystore needs to be in PKCS12 format.
|
||
You can create a keystore in your actual directory using the following call
|
||
(replace ALIAS by your alias, it is just a name):
|
||
|
||
~~~~
|
||
keytool -genkey -v -storetype PKCS12 -keystore keystore.pkcs12 -alias ALIAS -keyalg RSA -keysize 2048 -validity 10000
|
||
~~~~
|
||
|
||
Now edit or create the file ~/.gradle/gradle.properties and set following values
|
||
(replacing PASSWD by the password you typed while creating the keystore, ALIAS as before and using the path to your
|
||
keystore):
|
||
|
||
~~~~
|
||
RELEASE_STORE_FILE=/PATH/TO/YOUR/keystore.pkcs12
|
||
RELEASE_STORE_PASSWORD=PASSWD
|
||
RELEASE_KEY_PASSWORD=PASSWD
|
||
RELEASE_KEY_ALIAS=ALIAS
|
||
~~~~
|
||
|
||
## Create Firebase Authentication file
|
||
|
||
To build with firebase support (all version but the ones for Fdroid) you need to get an
|
||
authentication file for firebase services offered by google. Therefore please follow
|
||
https://firebase.google.com/docs/android/setup to create your own project. You need to
|
||
register for the packages com.foobnix.pdf.info and com.foobnix.pdf.reader.a1. This way
|
||
you will get a google-services.json file that you have to place in the app folder of
|
||
the repository.
|
||
|
||
For this project only Analytics is used, so a spakling plan is all you need.
|
||
|
||
## Librera Build on MuPdf
|
||
|
||
~~~~
|
||
cd Builder
|
||
./link_to_mupdf_x.x.x.sh (Change the paths to mupdf and jniLibs folders)
|
||
cd ..
|
||
./gradlew assembleLibrera
|
||
~~~~
|
||
|
||
## Building for Treader for Android
|
||
|
||
If you wish to build for Treader (e.g. not using google services, Internet) you can run the build with
|
||
|
||
~~~~
|
||
cd Builder
|
||
./link_to_mupdf_x.x.x.sh
|
||
cd ..
|
||
./gradlew assembleFdroid
|
||
~~~~
|
||
|
||
|
||
## Treader depends on:
|
||
|
||
LibreraReader： https://github.com/foobnix/LibreraReader
|
||
|
||
apache： https://www.apache.org/
|
||
|
||
LibreOfficeAndroid： https://github.com/popboyking/LibreOffice-android
|
||
|
||
MuPDF - (AGPL License) https://github.com/ArtifexSoftware/mupdf
|
||
|
||
* ebookdroid
|
||
* djvulibre
|
||
* hpx
|
||
* junrar
|
||
* glide
|
||
* libmobi
|
||
* commons-compress
|
||
* eventbus
|
||
* greendao
|
||
* jsoup
|
||
* juniversalchardet
|
||
* commons-compress
|
||
* okhttp3
|
||
* okhttp-digest
|
||
* okio
|
||
* rtfparserkit
|
||
* java-mammoth
|
||
* zip4j
|
||
|
||
Treader is distributed under the GPL
|
||
|
||
## License
|
||
|
||
See the [LICENSE](LICENSE.txt) file for license rights and limitations (GPL v.3).
|