Update install instructions

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

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).

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.