Download as
Browse Code »

Commit 0fe544d65a8436e73abb00177f8e988ea66b572f

Authored by Eder Soares
Committed by GitHub
2 parents a9d5182b 70ed96dd
Exists in master

Merge pull request #637 from portabilis/simplifica-readme 

[2.2] Simplifica o readme
Showing 1 changed file with 36 additions and 71 deletions   Show diff stats
readme.md
  Diff comments   View file @0fe544d
... ... @@ -15,10 +15,9 @@ país por meio da educação. Junte-se a nós!**
15 15  
16 16 1. [Sobre o i-Educar](#sobre-o-i-educar)
17 17 2. [Comunicação](#comunicação)
18   -3. [Roadmap de tecnologia](#roadmap-de-tecnologia)
19   -4. [Como contribuir](#como-contribuir)
20   -5. [Instalação](#instalação)
21   -6. [FAQ](#perguntas-frequentes-faq)
  18 +3. [Como contribuir](#como-contribuir)
  19 +4. [Instalação](#instalação)
  20 +5. [FAQ](#perguntas-frequentes-faq)
22 21  
23 22 ## Sobre i-Educar
24 23  
... ... @@ -55,26 +54,6 @@ colaboradores do projeto.
55 54 Qualquer outro grupo de discussão não é reconhecido oficialmente pela
56 55 comunidade i-Educar e não terá suporte da Portabilis - mantenedora do projeto.
57 56  
58   -## Roadmap de tecnologia
59   -
60   -O i-Educar por ser um sistema antigo e por não ter seguido um padrão específico,
61   -precisa passar por um processo de melhoria para diminuir a quantidade de bugs,
62   -melhorar a manutenibilidade e enfim permitir a evolução através de features.
63   -
64   -### Passos iniciais
65   -
66   -- Adoção do [PSR1](https://www.php-fig.org/psr/psr-1/)
67   -- Adoção do [PSR2](https://www.php-fig.org/psr/psr-2/)
68   -- Adoção do [PSR4](https://www.php-fig.org/psr/psr-4/)
69   -- Iniciar a cobertura de testes para possibilitar refatorações
70   -
71   -### Planejamento Técnico
72   -
73   -Em nossa wiki você encontra um planejamento mais técnico de como devemos
74   -prosseguir com as melhorias e evoluções do nosso projeto.
75   -[Clique aqui](https://github.com/portabilis/i-educar/wiki/Planejamento-T%C3%A9cnico)
76   -para ler mais a respeito.
77   -
78 57 ## Como contribuir
79 58  
80 59 Contribuições são **super bem vindas**! Se você tem vontade de construir o
... ... @@ -90,17 +69,49 @@ ajudar a alcançar nossos objetivos.
90 69 - [Instalação em servidor](#instalação-em-servidor)
91 70 - [Instalação do pacote de relatórios](#instalação-do-pacote-de-relatórios)
92 71 - [Upgrade](#upgrade)
93   -- [Criando um build de distribuição](#criando-um-build-de-distribuição)
94 72  
95 73 ### Depêndencias
96 74  
97 75 Para executar o projeto é necessário a utilização de alguns softwares para
98 76 facilitar o desenvolvimento.
99 77  
  78 +#### Docker
  79 +
100 80 - [Docker](https://docs.docker.com/install/)
101 81 - [Docker Compose](https://docs.docker.com/compose/install/)
102 82 - [Git](https://git-scm.com/downloads)
103 83  
  84 +#### Servidor
  85 +
  86 +- [PHP](http://php.net/) versão 7.2 ou maior
  87 +- [Postgres](https://www.postgresql.org/) versão 9.5 ou superior
  88 +- [Nginx](https://www.nginx.com/)
  89 +
  90 +As seguintes extensões do PHP são necessárias:
  91 +
  92 +- bcmath
  93 +- ctype
  94 +- curl
  95 +- dom
  96 +- fileinfo
  97 +- gd
  98 +- iconv
  99 +- json
  100 +- libxml
  101 +- mbstring
  102 +- openssl
  103 +- pcre
  104 +- PDO
  105 +- pgsql
  106 +- Phar
  107 +- SimpleXML
  108 +- tokenizer
  109 +- xml
  110 +- xmlreader
  111 +- xmlwriter
  112 +- zip
  113 +- zlib
  114 +
104 115 ### Instalação utilizando Docker
105 116  
106 117 > ATENÇÃO: Essa forma de instação tem o objetivo de facilitar demonstrações e
... ... @@ -182,42 +193,6 @@ Antes de tudo faça [download](https://github.com/portabilis/i-educar/releases)
182 193 da versão mais recente do i-Educar e extraia o conteúdo do release em uma pasta
183 194 no seu servidor. O instalador está disponível desde a versão `2.1.0`.
184 195  
185   -#### Requerimentos
186   -
187   -Para executar o i-Educar em um servidor você precisa dos seguintes programas:
188   -
189   -- [PHP](http://php.net/) versão 7.2 ou maior
190   -- [Postgres](https://www.postgresql.org/) versão 9.5 ou superior
191   -- [Nginx](https://www.nginx.com/)
192   -
193   -Você precisa das seguintes extensões para PHP:
194   -
195   -- bcmath
196   -- ctype
197   -- curl
198   -- dom
199   -- fileinfo
200   -- gd
201   -- iconv
202   -- json
203   -- libxml
204   -- mbstring
205   -- openssl
206   -- PDO
207   -- pgsql
208   -- Phar
209   -- SimpleXML
210   -- tokenizer
211   -- xml
212   -- xmlreader
213   -- xmlwriter
214   -- zip
215   -- zlib
216   -- pcre
217   -
218   -O instalador do i-Educar te avisa caso alguma extensão esteja faltando então não
219   -se preocupe em instalar tudo agora.
220   -
221 196 #### Configurando o servidor
222 197  
223 198 O **Nginx** precisa estar devidamente configurado para rodar o i-Educar e
... ... @@ -272,16 +247,6 @@ e siga as instruções de instalação.
272 247  
273 248 - [Upgrade para 2.2 da 2.1](https://github.com/portabilis/i-educar/wiki/Upgrade-para-2.2-da-2.1).
274 249 - [Upgrade para 2.1 da 2.0](https://github.com/portabilis/i-educar/wiki/Upgrade-para-2.1-da-2.0).
275   -
276   -#### Criando um build de distribuição
277   -
278   -Para criar um build de distribuição de uma nova versão do i-Educar basta
279   -executar o script `build` da pasta `scripts`:
280   -
281   -```bash
282   -# (Docker) docker-compose exec php scripts/build
283   -scripts/build
284   -```
285 250  
286 251 ## Perguntas frequentes (FAQ)
287 252  
... ...