Contexto
O repositório scieloorg/spsvalidator possui hoje um README.md em spsvalidator/README.md com instruções básicas de desenvolvimento, build e troubleshooting. Não existe um README.txt no projeto.
O README.md atual cobre:
- Execução em desenvolvimento
- Modo navegador (
--browser)
- Build por SO (macOS)
- Troubleshooting de
.app, pkg_resources e requests
Porém há lacunas e inconsistências que um documento mais completo poderia endereçar.
Problema / motivação
- Falta documentação introdutória sobre o que é o spsvalidator, para quem é destinado e qual problema resolve (validação de pacotes SPS
.zip).
- O
README.md referencia caminhos desatualizados (apps/spsvalidator/) enquanto a estrutura real do repositório é spsvalidator/.
- Não há descrição da arquitetura (Flask + Pywebview + SQLite, integração com
packtools).
- Instruções de build para Linux e Windows estão apenas em
packaging/README.md, de forma mínima.
- Não há seções sobre requisitos do sistema, testes, contribuição ou licença.
- Um
README.txt em texto puro seria útil para distribuições empacotadas (.app, .exe, AppImage) onde o usuário final pode não ter acesso ao repositório GitHub.
Contexto
O repositório scieloorg/spsvalidator possui hoje um
README.mdemspsvalidator/README.mdcom instruções básicas de desenvolvimento, build e troubleshooting. Não existe umREADME.txtno projeto.O
README.mdatual cobre:--browser).app,pkg_resourceserequestsPorém há lacunas e inconsistências que um documento mais completo poderia endereçar.
Problema / motivação
.zip).README.mdreferencia caminhos desatualizados (apps/spsvalidator/) enquanto a estrutura real do repositório éspsvalidator/.packtools).packaging/README.md, de forma mínima.README.txtem texto puro seria útil para distribuições empacotadas (.app,.exe, AppImage) onde o usuário final pode não ter acesso ao repositório GitHub.