Aqui está uma sugestão para o seu arquivo README no GitHub:
Este projeto em Python é voltado para alunos de graduação em Direito, facilitando o estudo da dosimetria da pena. Ele oferece uma interface simples e prática para calcular a pena de acordo com os parâmetros legais, tornando o processo mais acessível e didático.
- Seleção de crime, agravantes e outros detalhes relevantes
- Cálculo automático do tempo de pena
- Interface amigável e fácil de usar
O projeto está disponível em duas versões:
- Versão .exe: Basta baixar e executar o aplicativo, sem necessidade de instalação de dependências.
- Versão em Python: Código-fonte completo para desenvolvedores ou alunos que desejam estudar e modificar o projeto.
interface.py: Cuida da interface do projeto e das questões estéticas.dosidosi.py: Realiza o cálculo da pena, contendo a definição dos crimes e suas respectivas penas.
Para executar a versão Python, é necessário ter instalado:
- Python 3.x
- Bibliotecas necessárias
Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou enviar pull requests.