diff --git a/README.md b/README.md index 2e20dbb8..1caea769 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,50 @@ -#PORQUE ? +# POR QUE ? -##Premissas para a escolha +## Premissas para a escolha -1. Editado via web -2. exportado para qualquer formato, de preferencia sem BD -3. não requerer conhecimento de Html -4. Não requerer conhecimento de Python ou qualquer outro conhecimento técnico. +1. Editado via web; +2. Exportado para qualquer formato, de preferencia sem BD; +3. Não requerer conhecimento de HTML; +4. Não requerer conhecimento de Python ou qualquer outro conhecimento técnico. 5. _NÃO requerer de forma nenhuma, que seja instalado algo na máquina local_ -Pensando na possibilidade de mantermos um site pra comunidade de maneira mais colaborativa onde qualquer um possa contribuir com conteúdo -e de maneira rápida, iremos fazer alguns testes com o GitGHub Pages. +Pensando na possibilidade de mantermos um site pra comunidade de maneira mais colaborativa, onde qualquer um possa contribuir com conteúdo, e de maneira rápida, iremos fazer alguns testes com o Github Pages. -O GitHub usa um sistema de site estático chamado _Jekyll_. +O GitHub também suporta um sistema de sites estáticos chamado [https://help.github.com/articles/using-jekyll-with-pages/](_Jekyll_). -Sobre o Jekyll: https://help.github.com/articles/using-jekyll-with-pages/ +> **ATENÇÃO**: A versão do Jekyll utilizada no Github difere da versão padrão. ->ATENÇÃO: A versão do jekyll utilizada no GitHub difere da versão padrão. +- [https://github.com/pythonbrasil/apyb](Novo repositorio) +- [http://pythonbrasil.github.io/apyb](Site de homologação) -Novo Repositorio : https://github.com/pythonbrasil/apyb -Site de homologação: http://pythonbrasil.github.io/apyb. +> O branch para o site é o `__gh-pages__` +> O `master` não altera o site ->O branch para o site é o __gh-pages__ ->o master não altera o site - -###Porque usar isso ?? +### Por que usar isso? 1. Basta ter uma conta no GitHub. 2. Consigo editar via WEB -3. O site não tem senha, mas é automaticamente versionado. +3. O site não possui senha, mas é automaticamente versionado. -###Porque não usar algo da comunidade Python ? +### Por que não usar algo da comunidade Python? -Porque a tecnologia não pode estar entre o voluntário que quer colaborar -e a publicação do conteúdo. +Porque a tecnologia não pode estar entre o voluntário que quer colaborar e a publicação do conteúdo. -###Porque não usar o Pelican ou outro publicador de sit estático ? +### Por que não usar o Pelican ou outro publicador de site estático? -Porque teria que instalar coisas na máquina local para poder atualizar o site +Porque seria necessário instalar dependências na máquina local para podermos atualizar o site. -###Mas somos todos programadores. +### Mas somos todos programadores! -Não, não somos. -Mas mesmo entre os dev temos conhecimentos distintos, muitos da comunidade não querem saber como publicar um site, nem mesmo estático. +Não, não somos. Mas mesmo entre os *dev*, temos conhecimentos distintos, muitos da comunidade não querem saber como publicar um site, nem mesmo estático. -Independente de ser ou não programador, ou conhecer ou não __python__, acho que podemos tentar ter um site que __qualquer um__ com o mínimo de boa vontade consiga contribuir. +Independente de ser ou não programador, ou conhecer ou não Python, acho que podemos tentar ter um site que **qualquer um** com o mínimo de boa vontade consiga contribuir. _O mínimo de boa vontade é ter uma conta no GitHub_ -Então para que o site estático seja testado e se torne possível fizemos este repositório. +Então, para que o site estático seja testado e se torne possível, fizemos este repositório.