Author: Pedro Lucas Porcellis <pedrolucasporcellis@gmail.com>
Improve description of README
README.md | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++----
diff --git a/README.md b/README.md index 0a8b5ce13c8153d3b9f053473b227e3b3744bb89..61b9cc214cb52e0bcd64a4d10e691b2d8e6dce42 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,79 @@ # Software Livre no Estado -Repositório contendo código fonte do manifesto por software livre nas -empresas estatais +Repositório contendo código fonte do Manifesto por Software Livre nas +empresas estatais do Brasil e por defesa da soberania tecnológica +nacional. + +Ainda em construção, leia mais abaixo. + +## Como é feito? + +O projeto em si consta de um único arquivo no formato markdown +e é processado em um site usando o **Pandoc** através de um **Makefile**. + +- Pandoc - É um conversor de formatos universal, [veja na documentação oficial os passos para instalar](https://pandoc.org/installing.html) no seu sistema +- Makefile - É um arquivo "universal" contendo uma série de diretivas de como +construir algo. Se você usa alguma distribuição GNU/Linux ou macOS você +já tem ele instalado. + + +``` +softwarelivrenoestado.com.br/ +├── footer.html # Rodapé do projeto +├── header.html # Cabeçalho com fontes e folha de estilo +├── LICENSE # Licença (GPL 3.0) +├── Makefile # Regras de construção +├── MANIFESTO.md # Manifesto no formato markdown +├── README.md # Esse arquivo que você está lendo +└── style.css # Folha de estilos CSS +``` ## Contribuindo -Clone o repositório, e mande um patch para a lista de discussão -[~porcellis/softwarelivrenoestado@lists.sr.ht](mailto:~porcellis/softwarelivrenoestado@lists.sr.ht) -ou diretamente para o meu email -[porcellis@eletrotupi.com](mailto:porcellis@eletrotupi.com) +A ideia é construir com várias mãos. Atualmente temos uma lista +no Telegram ([t.me/manifesto_software_livre][telegram]), mas a ideia +é migrar para lista de email onde permite uma conversa mais fluida +e independente (apenas enviando um email). + +Lembre-se de enviar o email no formato de texto puro. + +[telegram]: https://t.me/manifesto_software_livre + +### Eu quero ajudar no site + +Maneiro! Hoje temos um arquivo nesse repositório, chamado +`MANIFESTO.md`, no [formato markdown][markdown], que é um formato simples para +texto e estamos usando Git para versionar e manter controle das mudanças +feitas no manifesto e no site. Sugiro que, caso você ainda não seja, se +familiarize com esses conceitos antes[^1]. + +Caso você já seja familiarizado, basta clonar o repositório: + +`git clone https://git.sr.ht/~porcellis/softwarelivrenoestado.com.br` + +Modificar o `MANIFESTO.md`, commitar e enviar um patch para a lista de discussão + +`git send-email --annotate to="~porcellis/softwarelivrenoestado@lists.sr.ht" HEAD^` + +[markdown]: https://markdown.net.br + +### Git? Enviar patch? + +O Git é um sistema livre e distribuido de versionamento de projetos, +conheça mais no [Guia de Consulta Rápida do +Git](https://www.digitalocean.com/community/tutorials/como-usar-o-git-um-guia-de-consulta-rapida-pt). + +Por ser um sistema distribuido, e não centralizado (_cof, cof Github_) +o git é feito para trabalhar em cima do email, então para mandar as suas +modificações, basta disparar um email contendo o Patch já formatado. +O Git oferece isso nas suas ferramentas, o comando `git-send-email (1)`, +bastando instruir o git por onde ele deve enviar o email. Leia um +[passo-a-passo aqui (em inglês)][patches-en] e [aqui (em português)][patches-pt-br] + +[patches-en]: https://git-send-email.io +[patches-pt-br]: https://imasters.com.br/desenvolvimento/dica-git-da-semana-patches-por-e-mail + +## Licença + +O código desse site está sob os termos da licença [GNU +GPL-3](https://www.gnu.org/licenses/gpl-3.0.html).