Skip to content

docs: reescrever o README com progresso, catálogo e guia de execução - #5

Merged
marloon-dev merged 1 commit into
mainfrom
docs/readme
Oct 4, 2026
Merged

marloon-dev merged 1 commit into
mainfrom
docs/readme

Conversation

@marloon-dev

Copy link
Copy Markdown
Owner

Resumo

Substitui o README de 3 linhas por documentação completa do repositório.

README

  • Cabeçalho com badges (Python, CI, versão, Conventional Commits, licença) e sumário.
  • Progresso por Mundo: Mundo 1 35/35, Mundo 2 17/36, Mundo 3 a iniciar.
  • Como executar: clone, ambiente virtual, dependências opcionais e observações (VLC, Tkinter, cores ANSI no Windows).
  • Estrutura de pastas comentada.
  • Catálogo recolhível com links para cada script: 6 de nivelamento/extra, 9 aulas e 35 desafios do Mundo 1, 17 exercícios do Mundo 2 (+ 053 em desenvolvimento).
  • Convenções (commits, tipos, versões, nomes) e roadmap.

Também

  • requirements.txt com as únicas dependências externas (emoji, python-vlc).
  • .github/workflows/ci.yml: compila todos os .py em Python 3.10 e 3.13 a cada PR e push na main.

Verificação

  • python -m compileall passa em todos os scripts (Python 3.14 local).
  • Todos os links relativos do README apontam para arquivos existentes.

Closes #4

🤖 Generated with Claude Code

- Badges, sumário e progresso por Mundo.
- Catálogo com links para as 9 aulas e 35 desafios do Mundo 1, os 17
  exercícios do Mundo 2 e os exercícios de nivelamento.
- Como executar, dependências opcionais (requirements.txt) e estrutura.
- Convenções de commits, versões e nomes, e roadmap.
- CI que verifica a sintaxe de todos os scripts em Python 3.10 e 3.13.

Closes #4

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@marloon-dev
marloon-dev merged commit b6ae3cc into main Oct 4, 2026
2 checks passed
@marloon-dev
marloon-dev deleted the docs/readme branch October 4, 2026 22:45
marloon-dev added a commit that referenced this pull request Nov 7, 2026
docs: reescrever o README com progresso, catálogo e guia de execução
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: README completo do repositório

1 participant