Merge pull request #250 from selmf/translate_changelog

Translate changelog and update build instructions
This commit is contained in:
Luis Ángel San Martín 2021-05-16 16:36:58 +02:00 committed by GitHub
commit 10e6b85341
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 152 additions and 136 deletions

View File

@ -1,9 +1,5 @@
# YACReader Changelog
Please note: this is a work in progress. Keeping a changelog has been neglected
in the past so information is missing and older release information is in
spanish only. Sorry for the mess.
Version counting is based on semantic versioning (Major.Feature.Patch)
## WIP
@ -14,7 +10,7 @@ Version counting is based on semantic versioning (Major.Feature.Patch)
* New search engine.
* New `manga` field added to comics and folders to tag content as manga, any content added to a manga folder will become manga automatically.
* Support for HTML in comic synopsis, this fixes the synopsis when it comes from Comic Vine with HTML tags.
* Improve keyboard navigation in Comic Vine dialog.
* Improve keyboard navigation in Comic Vine dialog.
## 9.7.1
### YACReader
@ -155,119 +151,119 @@ Version counting is based on semantic versioning (Major.Feature.Patch)
* Bug fixes.
## 7.1.0
* Añadida opción para resetear el rating de un comics
* Corregidos bugs que afectaban a la información de página.
* Corregido error que marcaba un comic terminado como empezado si se volvía a leer.
* Añadidos 2 estados para las carpetas (Completo/Terminado)
* Corregido bug en la comunicación YACReaderLibrary <-> YACReader
* Añadidas las acciones relativas a los comics al menú contextual de la tabla de cómics.
* Corrgido bug que provocaba el crecimiento ilimatado del log del servidor
* Corregidos bugs menores
* Added option to reset the rating of a comic book.
* Fixed bugs affecting page information.
* Fixed bug that marked a finished comic as started if it was read again.
* Added 2 statuses for folders (Complete/Completed).
* Fixed bug in YACReaderLibrary <-> YACReader communication.
* Added actions related to comics to the context menu of the comics table.
* Fixed bug that caused unlimited server log growth.
* Fixed minor bugs
## 7.0.2 (Sólo MacOSX)
* Eliminado el uso de Poppler en la versión de MacOSX
* Trabajo en traducciones.
* Corregidos bugs menores
## 7.0.2 (MacOSX only)
* Removed Poppler usage in MacOSX version.
* Work on translations.
* Fixed minor bugs
## 7.0.1
* Añadido QsLog a YACReader
* Corregido bug en la comunicación YACReaderLibrary <-> YACReader
* Added QsLog to YACReader
* Fixed bug in YACReaderLibrary <-> YACReader communication.
## 7.0 (Final)
* Corregidos eventos de teclado en algunos diálogos
* Corregido soporte para archivos Rar en sistemas Unix
* Corregidos problemas borrando cómics
* Mejorada la gestión de errores
* Corregida la comunicación entre YACReader y YACReaderLibrary
* Corregida la toolBar en MacOSX
* Mejorada la compatabilidad de OpenGL en tarjetas NVIDIA
* Corregidos bugs menores
* Fixed keyboard events in some dialogs
* Fixed support for Rar archives on Unix systems
* Fixed problems deleting comics
* Improved error handling
Fixed communication between YACReader and YACReaderLibrary * Fixed communication between YACReader and YACReaderLibrary
* Fixed the toolBar in MacOSX
* Improved OpenGL compatibility on NVIDIA cards
* Fixed minor bugs
## 6.9 (No pública)
* Añadida la apertura automática del siguiente/anterior cómic al llegar al final/portada del cómic actual
* Corregido el comportamiento del diálogo de nueva versión detectada. Ahora avisa una vez al día o si el usuario lo elige cada 14 días.
* Corregido el ajuste a lo ancho del título de la toolbar en YACReaderLibrary.
* Añadido log a YACReaderLibrary (permitirá a los usuarios ofrecer más información sobre sus bugs)
* Corregido bug en el historial de navegación (y al editar comics) después de usar el motor de búsqueda.
## 6.9 (internal)
* Added automatic opening of the next/previous comic when reaching the end/cover of the current comic
* Fixed behavior of new version detected dialog. Now warns once a day or if user chooses every 14 days.
* Fixed the width adjustment of the toolbar title in YACReaderLibrary.
* Added log to YACReaderLibrary (will allow users to provide more information about their bugs).
* Fixed bug in browsing history (and editing comics) after using search engine.
## 6.8 (No pública)
* Corregido bug que causaba un cierre inesperado después de cambiar el modo de sincronización vertical (flow)
* Corregido bug que causaba que la toolbar en el visor no se pudiese ocultar/mostrar sin un cómic abierto
* Mejorada la gestión de errores al abrir cómics
* Corregidos algunos bugs relacionados con la apertura de cómics
* Añadida función de rating
* El visor ahora puede abrir archivos de imagen directamente. Si se abre un archivo de imagen se abre el directorio que lo contiene con todas las imágenes.
* Corregida la ordenación de carpetas y cómics usada en la navegación desde dispositivos iOS
## 6.8 (internal)
* Fixed bug that caused unexpected shutdown after changing the vertical sync mode (flow).
* Fixed bug that caused toolbar in viewer could not be hidden/shown without an open comic book
* Improved error handling when opening comics
* Fixed some bugs related to comic opening
* Added rating function
* The viewer can now open image files directly. Opening an image file opens the directory containing the file with all images.
* Fixed sorting of folders and comics used in browsing from iOS devices.
## 6.7 (No pública)
* Añadidos nuevos campos en la base de datos para almacenar información adicional sobre cómics: rating, página actual, bookmarks y configuración de imagen
* Añadida comunicación entre YACReaderLibrary y YACReader para poder almacenar el progreso de los cómics e información adicional
## 6.7 (internal)
* Added new fields in the database to store additional information about comics: rating, current page, bookmarks and image settings.
* Added communication between YACReaderLibrary and YACReader to be able to store comics progress and additional information
## 6.6 (No pública)
* Modificado YACReader para que abra los archivos comprimidos usando 7z.dll (.so, .dylib)
* YACReader abre ahora los cómics por la última página leída.
* Corregido bug que causaba que algunos cómics no se pudiesen abrir desde YACReaderLibrary en YACReader
* Corregido el modo en el que se actualizaba la "information label"
## 6.6 (internal)
* Modified YACReader to open compressed files using 7z.dll (.so, .dylib)
* YACReader now opens comics by the last page read.
* Fixed bug that caused that some comics could not be opened from YACReaderLibrary in YACReader.
* Fixed the way in which the "information label" was updated.
## 6.5
* Nueva interfaz principal de YACReaderLibrary y YACReader
* Corregido bug que causaba que el servidor no se activase en el primer arranque en MacOSX
* Corregido bug que causaba un fallo al cerrar YACReaderLibrary cada vez que se usaba el servidor
* Nuevo diseño para el diálogo de propiedades de los cómics.
* Añadida navegación alante y atrás de las carpetas visitadas.
* La edición del nombre de una biblioteca no fuerza ahora que se recargue la biblioteca
* Corregido el color de fondo en la lupa
* Nuevo botón para ajustar a lo alto
* Eliminada la opción always on top
* Mostrar en carpeta contenedora arreglado en Windows y MacOSX
* New main interface of YACReaderLibrary and YACReader
* Fixed bug that caused the server not to activate on first boot on MacOSX
* Fixed bug that caused a crash when closing YACReaderLibrary every time the server was used
* New design for the comic properties dialog.
* Added forward and backward navigation of visited folders.
* Editing a library name does not force library reloading now.
* Corrected the background color in the magnifying glass.
* New button to adjust to top
* Removed always on top option
* Show in container folder fixed on Windows and MacOSX
## 6.4 (No pública)
* Normalizado el renderizado de páginas en modo doble página
* Añadida la función de borrar cómics desde el disco duro
* Nuevos iconos de la barra de herramientas de cómics
## 6.4 (internal)
* Normalized rendering of pages in double page mode
* Added delete comics from hard disk function
* New comic toolbar icons
## 6.3 (No pública)
* Mejorada la gestión de errores relacionada con las bibliotecas
* Añadido botón que permite ocultar las portadas en la pantalla de importación
* Añadidos títulos "Bibliotecas" y "Carpetas" a la barra de navegación
* Nuevos iconos para seleccionar la carpeta raíz, expandir y contraer todos.
* Botón para cambiar el puerto del servidor por el usuario.
* Ahora las columnas de la lista de cómics pueden reordenarse
* Ahora YACReaderLibrary sólo permite una instancia ejecutandose.
* Columna leído añadida.
* Cambiado estilo de la lista de cómics
* Corregidos bugs relacionados con realizar operaciones sobre cómics cuando no había ninguno seleccionado en la lista de cómics
## 6.3 (internal)
* Improved error handling related to libraries
* Added button to hide cover art in the import screen
* Added "Libraries" and "Folders" headings to the navigation bar
* New icons to select root folder, expand and collapse all.
* Button to change the server port by the user.
* Comic list columns can now be reordered.
* YACReaderLibrary now allows only one instance running.
* Read column added.
* Comic list style changed.
* Fixed bugs related to perform operations on comics when there was none selected in the comics list.
## 6.2
* Nueva ventana de "bienvenida"
* Nueva ventana de importar/actualizar
* Nuevo control para la búsqueda
* Nueva imagen para las marcas de cómics leídos (sólo en OpenGL)
* Cambiada la distribución de algunos iconos
* Cambiado el modo de eliminar la metainformación (borrar base de datos/portadas de disco)
* Ocultadas las opciones avanzadas de configuración de YACReader Flow, accesibles ahora tras pulsar un botón (diálogos de configuración más simples)
* New "welcome" window
* New import/update window
* New control for search
* New image for the marks of read comics (OpenGL only)
* Changed the layout of some icons
* Changed the way to delete meta information (delete database/disk covers)
* Hidden YACReader Flow advanced configuration options, accessible now after pressing a button (simpler configuration dialogs)
## 6.0.1 (No pública)
* Corregido bug al usar las teclas Inicio/fin
* Corregido bug que al arrancar YACReaderLibrary por primera vez causaba que no se mostrasen las portadas (sólo bajo ciertas circunstancias)
* Añadidos algunos atajos de teclado a YACReaderLibrary a los ya existentes
## 6.0.1 (internal)
* Fixed bug when using Home/end keys
* Fixed bug that when starting YACReaderLibrary for the first time caused that the covers were not shown (only under certain circumstances)
* Added some keyboard shortcuts to YACReaderLibrary to the already existing ones
## 6.0
* Mejorada la velocidad de inicio gracias al uso de /LTCG como opción de compilación
* Corregido bug relacionado con OpenGL que causaba consumo excesivo de CPU en tarjetas NVidia
* Añadidos iconos para cada tipo de archivo soportado en YACReaderLibrary
* Cambiado el icono "folder" en YACReaderLibrary
* Añadida barra para ajustar el ancho de página en la toolbar de YACReader
* Añadido widget para la information label
* Añadido nuevo estilo visual a goToFlow
* Añadidos filtros para controlar el brillo, el contraste y el valor gamma
* Añadidas notificaciones de portada y última página
* InformationLabel se muestra ahora en la esquina superiror derecha.
* InformationLabel se muestra en 3 tamaños diferentes en función de la resolución
* Corregido bug que causaba que las marcas de cómic leído no se dibujasen adecuadamente.
* Se recuerda si se debe mostrar o no la "label" información.
* Corregido bug que provocaba el fallo de YACReader al pasar muy rápido las páginas.
* Añadida columna "Tamaño" a la lista de cómics en YACReaderLibrary
* Añadida la ordinación "natural" de los comics que hay en directorio del cómic actual.
* Corregido bug que causaba que se abriese el cómic erroneo en YACReaderLibrary.
* Cambiado el modo en el que se cargan los lenguages, ahora se pueden añadir traducciones sin necesidad de recompilar.
* Improved startup speed thanks to the use of /LTCG as a compile option
* Fixed OpenGL related bug that caused excessive CPU consumption on NVidia cards
Added icons for each supported file type in YACReaderLibrary * Added icons for each supported file type in YACReaderLibrary
* Changed "folder" icon in YACReaderLibrary
Added page width adjustment bar in YACReader toolbar * Added widget for page width in YACReader toolbar
* Added widget for information label
* Added new visual style to goToFlow
* Added filters to control brightness, contrast and gamma value * Added new filters to control brightness, contrast and gamma value
* Added front page and last page notifications
* InformationLabel is now displayed in the upper right corner.
* InformationLabel is displayed in 3 different sizes depending on resolution.
* Fixed bug that caused read comic marks not to be drawn properly.
* InformationLabel now remembers whether or not to display the information label.
* Fixed bug that caused YACReader to crash when turning pages too fast.
* Added "Size" column to the comics list in YACReaderLibrary.
* Added "natural" sorting of the comics in the current comic directory.
* Fixed bug that caused the wrong comic to open in YACReaderLibrary.
* Changed the way languages are loaded, now you can add translations without recompiling.

View File

@ -3,63 +3,83 @@
YACReader and YACReaderLibrary are build using qmake. To build and install the
program, run:
> qmake-qt5 CONFIG+=[Options]
> make
> make install
```
qmake CONFIG+=[Options]
make
make install
```
from the source dir. For separate builds of YACReader or YACReaderLibrary,
from the top 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
folder. To build it, enter the folder and run the commands described above.
Note: If your system has multiple versions of Qt, you need to make sure you are
using qmake for Qt5
## Build dependencies:
- Qt >= 5.6 with the following modules:
- Qt >= 5.9 with the following modules:
- declarative
- quickcontrols
- sql
- script
- multimedia
- imageformats
- opengl
- sql-sqlite
- network
- A pdf rendering backend (optional, see below)
- qrencode (optional)
- 7zip or p7zip (see below)
- (lib)unarr (optional, see below)
- Backends for pdf rendering (optional) and file
decompression (see below)
- qrencode for QR code generation (optional)
Not all dependencies are needed at build time. For example the qml components in
YACReaderLibrary (GridView, InfoView) will only show a white page if the
required qml modules (declarative, quickcontrols) are missing.
This can also happen if these dependencies are too old (i.e Qt < 5.6 is used).
## Backends
### Decompression
Configure the library you want to use throught `qmake` `CONFIG`. `CONFIG += 7zip` or `CONFIG += unarr`, if not specified `7zip` is used in MacOS and Windows and `unarr` in Linux.
YACReader currently supports two decompression backends, 7zip and (lib)unarr. YACReader
defaults to 7zip for Windows and Mac OS and unarr for Linux and other OS, but you can
override this using one of the following config options:
`CONFIG+=7zip`
`CONFIG+=unarr`
#### 7zip
YACReader uses by default [7zip](https://www.7-zip.org/) for comic book archive
decompression. In MacOS and Linux, it uses [p7zip](http://p7zip.sourceforge.net/). Please read `compressed_archive/README_7zip.txt` for more details. This is the recomended library since supports a wider variety of formats, including RAR5 and 7z.
[7zip](https://www.7-zip.org/) and [p7zip](http://p7zip.sourceforge.net/)
are the default decompression backend for Windows and Mac OS builds.
They are recommended for these systems, as they currently have better support for 7z
files and support the RAR5 format.
As this backend requires specific versions of 7zip for Windows and p7zip for *NIX and
is not 100% GPL compatible (unrar License restriction), it is not recommended for
installations where you can't guarantee the installed version of (p7zip) or the license is an issue.
To build using this backend, you need to install additional sources to the build environment.
For more information, please refer to [README_7zip](compressed_archive/README_7zip.txt).
#### unarr
YACReader can use [(lib)unarr](https://github.com/selmf/unarr) for comic book archive
decompression. Most Linux distributions don't ship this library yet, so you will
probably have to build it yourself.
[(lib)unarr](https://github.com/selmf/unarr) is the default backend for Linux builds.
We recommend using (lib)unarr as a shared library, but we also support static
and embedded builds. Please consult the [README](compressed_archive/unarr/README.txt)
for more information on this topic.
As of version 1.0.1, it supports less formats than 7zip, notably missing RAR5 support and only having
limited support for 7z on git versions. However, this is rarely an issue in practice as the vast majority
of comic books use either zip or RAR4 compression, which is handled nicely by this backend.
The unarr backend is recommended for packaging, lightweight installations and generally for all users requiring
more stability than the 7zip backend can offer.
The recommended way to use this on Linux or other *NIX is to install it as a package, but you can also do an embedded build.
For more information, please consult the [README](compressed_archive/unarr/README.txt)
### PDF
Starting with version 9.0.0 YACReader supports the following pdf render engines:
Starting with version 9.0.0 YACReader supports the following pdf rendering engines:
- poppler (Linux/Unix default)
- pdfium (default for Windows and MacOS)
@ -70,7 +90,7 @@ To override the default for a given platform add CONFIG+=[pdfbackend] as an opti
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
for a long time, its 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 library that is available
prepackaged for Linux.
@ -80,23 +100,25 @@ prepackaged for Linux.
You can adjust the installation prefix as well als the path "make install" uses
to install the files.
>qmake PREFIX=DIR
`qmake PREFIX=DIR`
sets the default prefix (for example "/", "/usr", "/usr/local").
>make install INSTALL_ROOT=DIR
`make install INSTALL_ROOT=DIR`
can be used to install to a different location, which is usefull for packaging.
Default values:
>PREFIX=/usr
>INSTALL_ROOT=""
```
PREFIX=/usr
INSTALL_ROOT=""
```
On embedded devices that don't support desktop OpenGL, it is recommended to use
the no_opengl config option:
qmake-qt5 CONFIG+=no_opengl
`qmake CONFIG+=no_opengl`
This will remove any dependency on desktop OpenGL and hardlock YACReader's
coverflow to software rendering. Please note that it does not actually remove
@ -107,10 +129,10 @@ OpenGL from the build, the Qt toolkit will still make use of it.
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.
package request for your distribution.
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
AUR package for Archlinux and its 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

View File

@ -1,9 +1,7 @@
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).
you need to download the source code of 7zip 18.05 (Windows) or p7zip 16.02 (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).
YACReader is compiled using 7zip 18.05 and p7zip 16.02.
7zip is the recommended library to use is you want support for 7zip files and rar5.

View File

@ -1,4 +1,4 @@
Starting with YACReader 9.0.0 all versions of YACReader use (lib)unarr >= 1.0.1
Starting with YACReader 9.0.0 all versions of YACReader can 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!).