mirror/yacreader
1
0
Fork 0
mirror of https://github.com/YACReader/yacreader synced 2025-05-28 03:10:27 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update install instructions

Browse Source
This commit is contained in:
Felix Kauselmann 2018-01-17 21:09:11 +01:00
parent b87d5180c4
commit d1238bd22c
3 changed files with 46 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
INSTALL.md
View File

@ -7,7 +7,7 @@ program, run:
> make
> make install
from the source dir. For seperate builds of YACReader or YACReaderLibrary,
from the source dir. For separate builds of YACReader or YACReaderLibrary,
enter their respective subfolders and run the commands from there.
The headless version of YACReaderLibrary is located in the YACReaderLibraryServer
@ -35,14 +35,14 @@ folder. To build it, enter the folder and run the steps as described above.
Please note that not all of these dependencies are needed at build time.
A good example for this is YACReaderLibrary's GridView mode which will
silently fail and only show a white page if the proper qml modules
(declarative, quickcontrols) are not missing.
(declarative, quickcontrols) are missing.
## Backends
### Decompression
YACReader uses [(lib)unarr](https://github.com/selmf/unarr) for comic book
decompression. Most Linux distributions don't ship this library yet, so will
decompression. Most Linux distributions don't ship this library yet, so you will
probably have to build it yourself.
We recommend using (lib)unarr as a shared library, but we also support static
@ -53,10 +53,10 @@ for more information on this topic.
Starting with version 9.0.0 YACReader supports the following pdf render engines:
- poppler (Linux default)
- pdfium (Default for Windows and MacOS)
- pdfkit (macOS only)
- no_pdf (disables pdf support)
- poppler (Linux/Unix default)
- pdfium (default for Windows and MacOS)
- pdfkit (MacOS only)
- no_pdf (no pdf support)
To override the default for a given platform add CONFIG+=[pdfbackend] as an options
when running qmake.
@ -64,12 +64,12 @@ when running qmake.
While the Poppler backend is well tested and has been the standard for YACReader
for a long time, it's performance is a bit lacking. The pdfium engine offers
much better performance (about 10x faster on some pdf files we tested).
However, at the time of this writing, it is not a software that is available
However, at the time of this writing, it is not a library that is available
prepackaged for Linux.
### Other build options:
You can adjust the installation prefix as well als the path make install uses
You can adjust the installation prefix as well als the path "make install" uses
to install the files.
>qmake PREFIX=DIR
@ -91,7 +91,7 @@ the no_opengl config option:
qmake-qt5 CONFIG+=no_opengl
This will remove any dependency on desktop OpenGL and hardlock YACReader's
coverflow to software rendering. Please note that it doesn't actually remove
coverflow to software rendering. Please note that it does not actually remove
OpenGL from the build, the Qt toolkit will still make use of it.
@ -101,10 +101,12 @@ If you're compiling YACReader because there is no package available for your
Linux distribution please consider creating and submitting a package or filing a
package request.
While we do provide packages for .deb based distributions as well as an AUR
package for Archlinux, we are in need of packagers especially for RPM based
distributions. If you are interested, please contact @selmf on the YACReader
forums or write an email to info@yacreader.com
While we do provide packages for .deb and .rpm based distributions as well as an
AUR package for Archlinux and it's derivates, we are in need of downstream packagers
that are willing to make YACReader available as a standard package for their distro.
If you are interested, please contact @selmf on the YACReader forums or write
an email to info@yacreader.com
If you have already created a package please let us know so we can add it to
our downloads list ;)

22
compressed_archive/README_7zip.txt
View File

@ -1,13 +1,19 @@
If you are trying to compile YACReader with a 7zip decompression backend, you need to download de source code of 7zip (Windows) or p7zip (Linux/MacOSX).
If you are trying to compile YACReader with a 7zip decompression backend,
you need to download de source code of 7zip (Windows) or p7zip (Linux/MacOSX).
Please extract it and rename the folder to lib7zip (Windows) or libp7zip (Linux/MacOSX), then copy it to $YACREADER_SRC/compressed_archive/ (this
folder).
Please extract it and rename the folder to lib7zip (Windows) or libp7zip (Linux/MacOSX),
then copy it to $YACREADER_SRC/compressed_archive/ (this folder).
YACReader is compiled using 7zip/p7zip 9.20.1 and will not work with newer versions.
On Linux/Unix this means your YACReader installation will stop working if you update your installation of p7zip to a newer version. If you wish to keep using
p7zip with YACReader, you can copy 7z.so and Codecs/Rar29.so from p7zip 9.20.1 to "/usr/lib/yacreader/". YACReader will then detect these files and use
them instead of the system provided p7zip files which allows you to keep both YACReader and an up to date p7zip installation.
On Linux/Unix this means your YACReader installation will stop working if you
update your installation of p7zip to a newer version. If you wish to keep using
p7zip with YACReader, you can copy 7z.so and Codecs/Rar29.so from p7zip 9.20.1
to "/usr/lib/yacreader/". YACReader will then detect these files and use
them instead of the system provided p7zip files which allows you to keep both
YACReader and an up to date p7zip installation.
Please keep in mind this is only a workaround that is provided for backwards compatibility and not intended as a long time solution.
It is recommended that you switch to unarr as a decompression backend instead (see README.txt in compressed_archive/unarr).
Please keep in mind this is only a workaround that is provided for backwards
compatibility and not intended as a long time solution.
It is recommended that you switch to unarr as a decompression backend instead
(see README.txt in compressed_archive/unarr).

21
compressed_archive/unarr/README.txt
View File

@ -1,6 +1,17 @@
To use unarr as a decompression engine when building YACReader, download https://github.com/zeniko/unarr/archive/master.zip and extract it in this folder.
This will build unarr as a part of YACReader (static build).
Starting with YACReader 9.0.0 all versions of YACReader use (lib)unarr >= 1.0.1
as decompression backend. For Windows and MacOSX precompiled libraries
are available in the dependencies folder (not included in the source tarballs!).
If you're on a Linux/Unix system and prefer to use unarr as a shared library, have a look at https://github.com/selmf/unarr/
This fork of unarr includes a CMake based build system that allows you to build and install unarr as a shared library. YACReader will detect and use
the installed library at build time if it is installed.
For all other operating systems or users who wish to compile unarr themselves,
source code and build instructions are available at https://github.com/selmf/unarr/
For best performance it is recommended to build and install unarr as a shared
library.
Users who prefer an embedded build can also download a snapshot from
https://github.com/selmf/unarr/archive/master.zip and extract it in this folder.
The build system will then detect the presence of the source code and include it
in the build process. However, as the embedded build option uses different
compiler flags and does not include any options to detect and make use of libraries
like zlib, bzip2 or lzma embedded builds will have slower extraction speed
and won't support zip files with bzip2 or xz compression.