CopyrightFixer/README.md

76 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2021-04-05 18:01:51 +03:00
# Copyright Fixer
2021-04-03 17:05:32 +03:00
2021-04-09 17:58:57 +03:00
<p align="center"><img src="res/CopyrighFixerBanner_web.png" alt="Logo"></p>
2021-04-09 17:41:01 +03:00
2021-04-05 18:01:51 +03:00
This is simple console tool for change all copyrigh labels of your source code.
2021-04-03 17:05:32 +03:00
2021-04-05 18:01:51 +03:00
## Support Features:
- [ ] Sign all not signed source files.
- [ ] Update copyright data for last owner
- [ ] Automaticly add new owner if the owner is changed
## Support Files types
* cpp
* hpp
* h
* cc
* qml
* pro
* txt
* py
2021-04-21 23:28:43 +03:00
## Arhitecture:
<p align="center">
<img src="./res/general application arhitecture.png">
</p>
2021-04-05 18:01:51 +03:00
## exemple
Sign not signed files.
``` bash
2021-05-13 23:07:14 +03:00
cfixer -sourceDir /path/sources -sign /path/to/copyright/file
2021-04-05 18:01:51 +03:00
```
## Support options
| option | arguments | discription |
|---------|------------|--------------|
| sourceDir | pathToSourceDirectory | This arrgument sets path to the source directory. By default it is sourceDir = **PWD** |
2021-05-13 23:07:14 +03:00
| sign | pathToFileWithSignPatern | This argument sets path to the sign patern. This is a required argument |
2021-04-05 18:01:51 +03:00
# This project supports next build targets:
2021-04-03 17:05:32 +03:00
| Command or make target | Description |
|------|------|
| **make test** | The run tests for a project (dependet of Qt Tests, so you need to add Qt in Cmake using CMAKE_PREFIX_PATH) |
| **make doc** | The generate a documentation for a project (dependet of doxygen) |
| **make deploy** | The generate distribution for a project (dependet of CQtDeployer) |
| **make release** | The prepare Qt Installer framework repository for a project, generate a snap package and APK file for android (dependet of CQtDeployer, snapcraft, AndroidDeployer). |
2021-04-06 16:51:59 +03:00
2021-04-21 23:28:43 +03:00
2021-04-06 16:51:59 +03:00
---
2021-04-06 18:05:50 +03:00
<p align="center">
<img src="./res/Credits.jpg">
</p>
2021-04-06 17:24:58 +03:00
2021-04-06 16:51:59 +03:00
Join the development fund and support QuasarApp to help with the development of our projects.
<a href="https://www.patreon.com/bePatron?u=9304737"><img src="https://img.shields.io/badge/ become a patron-red?&style=for-the-badge&logo=patreon&logoColor=white" height=30 width=180></a>
If you would like to use bitcoins to support us, you can transfer coins to these address. If you want to be included in the patron list, send an e-mail message - QuasarApp@yandex.by.
**Note**: You must send a message signed with address of the bitcoin wallet from which the payment was made.
2021-04-10 15:36:49 +03:00
<p align="center"><img src="res/qr.png" alt="qrcode"></p>
2021-04-06 16:51:59 +03:00
2021-04-10 15:39:18 +03:00
<p align="center">bitcoin: bc1qzuymq7jc9q2x04wcwstr45tu8klm46zfl20wyp</p>