mirror/yacreader
1
0
Fork 0
mirror of https://github.com/YACReader/yacreader synced 2025-07-18 21:14:33 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update docs a little bit

Browse Source
This commit is contained in:
Luis Ángel San Martín
2019-09-23 12:13:56 +02:00
parent 68ae40fda7
commit 3d29ab8836
2 changed files with 25 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -23,7 +23,6 @@ This software has been developed by Luis Ángel San Martín Rodríguez
See [INSTALL.md](./INSTALL.md)
## Contact
- Project home page : www.yacreader.com
- e-mail:
- info@yacreader.com
@ -37,7 +36,18 @@ See [INSTALL.md](./INSTALL.md)
If you need help or have any suggestion, please, send me an e-mail.
## Contributing
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. For small bug fixes it is usually ok to open a PR directly.
Contributions are not restricted to code, you can help the project by bringning new UI/UX ideas, designing new assets, writting manuals or tutorials, translating the apps, etc. If you are interested in DevOps, YACReader uses Azure Pipelines for CI/CD, any improvements in that area are welcome. Testing preleases is also really appreciated.
#### Code
YACReader uses `clang-format` to ensure a common style and avoid deviances from it. CI checks this and will fail if the correct format is not used. `clang-format` needs to be called recusivelly in all the folders because some of them have the own `.clang-format` file, mainly to exclude changing the format in thirdparty libraries which are included in the source code. I recommend to configure your development tools to use `clang-format`, you can try to use it manually, but please, do it always before commiting changes. I recommend using QtCreator configured properly, you can find a tutorial [here]( https://www.vikingsoftware.com/using-clang-format-with-qtcreator/).
#### CI/CD
Any PR will be validated through CI, and it will not be merged if CI fails.
#### Pull Requests
The base and target branch for any PR should always be `develop`.
## Donations
YACReader is free but it needs money to still be alive, so please,
if you like YACReader, visit the home page and make a donation.
YACReader is free but it needs money to still be alive, so please, if you like YACReader, visit the home page and make a donation.