Table of Contents

1. About
2. Scripts and Files
3. Setup
4. Roadmap
5. Contributing
6. License

About

Project Description

(back to top)

Scripts and Files

Script module	Description
<link_to_file>	description

Description of execution/workflow of files and scripts.

(back to top)

Setup

Scripts were intended to be used in a Windows machine with UV package and environment management.

For more details, see the UV documentation

Tests are described in the tests folder

Roadmap

This section presents a simplified view of the roadmap and knwon issues.

For more details, see the open issues

• Initial deployment
  • Create the project structure

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

(back to top)

License

Distributed under the GNU General Public License (GPL), version 3. See LICENSE.txt.

For additional information, please check https://www.gnu.org/licenses/quick-guide-gplv3.html

This license model was selected with the idea of enabling collaboration of anyone interested in projects listed within this group.

It is in line with the Brazilian Public Software directives, as published at: https://softwarepublico.gov.br/social/articles/0004/5936/Manual_do_Ofertante_Temporario_04.10.2016.pdf

Further reading material can be found at:

• http://copyfree.org/policy/copyleft
• https://opensource.stackexchange.com/questions/9805/can-i-license-my-project-with-an-open-source-license-but-disallow-commercial-use
• https://opensource.stackexchange.com/questions/21/whats-the-difference-between-permissive-and-copyleft-licenses/42#42

(back to top)

References

• UV Short Guide
• Readme Template

(back to top)