Author: Pedro Lucas Porcellis <pedrolucasporcellis@gmail.com>
Improve README
README.md | 72 ++++++++++++++++++++++++++++++++++++++++----------------
diff --git a/README.md b/README.md index 61b9cc214cb52e0bcd64a4d10e691b2d8e6dce42..4053e5ba061bac5120f411ff0f266b3c83473b25 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,18 @@ # Software Livre no Estado Repositório contendo código fonte do Manifesto por Software Livre nas -empresas estatais do Brasil e por defesa da soberania tecnológica +instituições públicas 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**. +e é transformado 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ê +construir alguma coisa. Se você usa alguma distribuição GNU/Linux ou macOS você já tem ele instalado. @@ -25,36 +24,58 @@ ├── 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 +├── resolucao.pdf # Backup da Resolução GE 016/2020 └── style.css # Folha de estilos CSS ``` ## Contribuindo -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). +A ideia é construir com várias mãos. Portando a metodologia ideal é de +se baixar esse repositório, modificar o manifesto e enviar as sugestões +de modificações na [lista de email][lista] para serem debatidas com todo mundo. -Lembre-se de enviar o email no formato de texto puro. +A [lista de email][lista] permite, não somente um espaço de diálogo +universal, como um espaço distribuido e simples, características +próprias do sistema de email que vinga a mais de 50 anos. + +De qualquer forma, também temos um grupo no Telegram +([t.me/manifesto_software_livre][telegram]), como um espaço de primeiro +contato, sempre visualizando de que o espaço de _discussão_ deve ser +a lista de email. + +Lembre-se de enviar o email no formato de texto simples, e não no +formato dado como normal ou padrão que é o formato HTML. Consulte as +informações do seu cliente/serviço de email para descobrir como +modificar. [telegram]: https://t.me/manifesto_software_livre +[lista]: https://lists.sr.ht/~porcellis/softwarelivrenoestado -### Eu quero ajudar no site +### Eu quero ajudar 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]. +`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, você se +familiarize com esses conceitos antes. -Caso você já seja familiarizado, basta clonar o repositório: +Caso você já tenha usado Git, 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 +Modificar o `MANIFESTO.md` usando seu editor favorito (Vim, Sublime Text, VSCodium) + +Registrar as suas mudanças: + +`git add MANIFESTO.md && git commit` + +Enviar um patch para a lista de discussão: `git send-email --annotate to="~porcellis/softwarelivrenoestado@lists.sr.ht" HEAD^` +Pronto! Todos inscritos na lista receberão seu PATCH e poderão opinar, +construindo um debate plural a respeito das suas sugestões. + [markdown]: https://markdown.net.br ### Git? Enviar patch? @@ -65,15 +86,24 @@ 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. +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] +bastando instruir o git por qual servidor de email ele usar para se +comunicar. 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 +## Não sou uma pessoa muito tecnológica, mas quero ajudar + +Tranquilo, você pode ajudar ainda divulgando o manifesto, gerando +e contribuindo com discussões na lista de email, sugerindo mudanças +e correções de ortografia no texto, etc. + ## 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). +GPL-3](https://www.gnu.org/licenses/gpl-3.0.html). E o conteúdo/texto +sobre as atribuições da [Creative Commons 4.0 +International](https://creativecommons.org/licenses/by/4.0/deed.pt_BR)