#Yacreader add a library manuals#
#Yacreader add a library install#

CI/CDĪny PR will be validated through CI, and it will not be merged if CI fails. I recommend using QtCreator configured properly, you can find a tutorial here. I recommend to configure your development tools to use clang-format, you can try to use it manually, but please, do it always before committing changes. clang-format file, mainly to exclude changing the format in third-party libraries which are included in the source code. clang-format needs to be called recursively in all the folders because some of them have the own. CI checks this and will fail if the correct format is not used. YACReader uses clang-format to ensure a common style and avoid deviances from it.

If you have the time and the energy, please open a PR with a script that automatizes any of these manual proceses. The best way to make sure you have all the thirdparty binaries in place is to check YACReader installation and copying the binaries in your output folder. YACReader needs to find its dependencies at runtime, make sure that Qt binaries are in your PATH and the third party binaries are next to the executable. The repo includes binaries for the dependencies needed for Windows (MSVC compiler) and macos (clang) but you need to configure 7zip/p7zip dependency manually, please take a look at compressed_archive/README_7zip.txt.

#Yacreader add a library install#

The project is adding support to Qt6 and it alreaady compiles under it but it is not ready to ship, so you need to make sure that everything works in both Qt5 and Qt6, you only need to install Qt5 for now and CI will check that everything builds with Qt6. In Windows I use Visual Studio Community Edition 2019 as build system and in macos I use Xcode, but I do all the coding using QtCreator. YACReader is developed in c++/Qt, so the first thing you need to do is to install a C++ compiler or environment that supports at least C++17 and Qt. Testing pre-releases is also really appreciated. If you are interested in DevOps, YACReader uses Azure Pipelines for CI/CD, any improvements in that area are welcome.

#Yacreader add a library manuals#

For small bug fixes it is usually ok to open a PR directly.Ĭontributions are not restricted to code, you can help the project by bringing new UI/UX ideas, designing new assets, writing manuals or tutorials, translating the apps, etc. If you are interested in contributing to the project the first step should be to contact me so we can plan together the best approach, you can send an e-mail or just open an issue in this repo. If you need help or have any suggestion, please, send me an e-mail. Getting YACReader Official releases:įrom OBS build service: Building from source: This software has been developed by Luis Ángel San Martín Rodríguez