Skip to content

Commit

Permalink
Atualizando Readme do projeto
Browse files Browse the repository at this point in the history
  • Loading branch information
wildemberg-sales committed Mar 4, 2024
1 parent 1679401 commit 7b0b7fb
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 12 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Grupo Querido Diário

<img src="./images/logo-querido-diario.jpeg" />

Este repositório é destinado a documentação do processo de evolução de software do projeto de código aberto [Querido Diário](https://queridodiario.ok.org.br/).
A seguir temos a lista de repositórios utilizados pelo time de desenvolvimento para a evolução deste software:

* [Front-End](https://github.com/Wildemberg-Projects/querido-diario-frontend)
* [Back-End](https://github.com/Wildemberg-Projects/querido-diario-backend)
* [API](https://github.com/Wildemberg-Projects/querido-diario-api)


## Contribuidores
| Foto | Nome | Github | Email |
| :--: | :--: | :----: | :---: |
| | Arthur Ferreira | [ArthurFerreiraRodrigues](https://github.com/ArthurFerreiraRodrigues) | [email protected] |
| | Ester Lino | [esteerlino](https://github.com/esteerlino) | [email protected] |
| | Cristian Furtado | [csafurtado](https://github.com/csafurtado) | [email protected] |
| | Raissa Oliveira | [raissamsoliveira](https://github.com/raissamsoliveira) | [email protected] |
| <img src="./images/will.jpeg" width="200px" /> | Wildemberg Sales | [wildemberg-sales](https://github.com/wildemberg-sales) | [email protected] |
Binary file added docs/images/logo-querido-diario.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/will.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 15 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
# Welcome to MkDocs
# Grupo Querido Diário

For full documentation visit [mkdocs.org](https://www.mkdocs.org).
<img src="./images/logo-querido-diario.jpeg" />

## Commands
Este repositório é destinado a documentação do processo de evolução de software do projeto de código aberto [Querido Diário](https://queridodiario.ok.org.br/).
A seguir temos a lista de repositórios utilizados pelo time de desenvolvimento para a evolução deste software:

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
* [Front-End](https://github.com/Wildemberg-Projects/querido-diario-frontend)
* [Back-End](https://github.com/Wildemberg-Projects/querido-diario-backend)
* [API](https://github.com/Wildemberg-Projects/querido-diario-api)

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
## Contribuidores
| Foto | Nome | Github | Email |
| :--: | :--: | :----: | :---: |
| | Arthur Ferreira | [ArthurFerreiraRodrigues](https://github.com/ArthurFerreiraRodrigues) | [email protected] |
| | Ester Lino | [esteerlino](https://github.com/esteerlino) | [email protected] |
| | Cristian Furtado | [csafurtado](https://github.com/csafurtado) | [email protected] |
| | Raissa Oliveira | [raissamsoliveira](https://github.com/raissamsoliveira) | [email protected] |
| <img src="./images/will.jpeg" width="200px" /> | Wildemberg Sales | [wildemberg-sales](https://github.com/wildemberg-sales) | [email protected] |
17 changes: 17 additions & 0 deletions docs/mkdocs-instrucoes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Welcome to MkDocs

For full documentation visit [mkdocs.org](https://www.mkdocs.org).

## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.

0 comments on commit 7b0b7fb

Please sign in to comment.