Skip to content

Commit

Permalink
Atualiza o README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Matheus Alves authored Mar 5, 2019
1 parent c5fd128 commit fbd4e9b
Showing 1 changed file with 25 additions and 7 deletions.
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,50 @@

Tamburetei vai te ajudar a fazer de tamburete aquela cadeira de CC. Direcionado ao curso de Ciência da Computação da UFCG, esse repositório é um trabalho colaborativo contendo dicas, links úteis e leites das disciplinas do curso. A ideia é que veteranos ajudem os novatos e ninguém mais passe sufoco em nenhuma cadeira. :)


## Como funciona?

Cada cadeira do curso vai possuir seu próprio diretório, nele estarão os seguintes conteúdos:

Arquivo | Finalidade
------- | -----------
**visaoGeralEDicas.md** | Contém a ementa, uma visão geral sobre a disciplina e algumas dicas rápidas para quem vai começar a cursá-la.
**linksUteis.md** | Contém links de qualquer tipo de material que possa ser útil para estudar o assunto da disciplina.
**dificuldadesComuns.md** | Contém a descrição das dificuldades mais comuns da disciplina, assim como dicas para superá-las e relatos de alunos que já a cursaram.
**extras.md** | Caso necessário, outros tópicos devem ser inseridos nesse arquivo.
**leites/** | Diretório com os leites dos períodos passados, separados por período (em seções do README.md ou em pastas). Preferencialmente contém apenas provas e listas de exercícios.
**implementacoes/** | Caso a disciplina possibilite, esse diretório se destina a implementações úteis, fáceis de entender e bem documentadas.
**resumos/** | Esse diretório se destina a resumos sobre assuntos especifícos da disciplina. Devem ser bem divididos e fáceis de entender.
**implementacoes/** | Esse diretório, que existe apenas para disciplinas em que seja pertinente, se destina a implementações úteis para os aqueles que estejam cursando a disciplina. Devem ser fáceis de entender e bem documentadas.
**dificuldadesComuns.md** | Contém a descrição das dificuldades mais comuns da disciplina e relatos de alunos que já a cursaram.
**extras.md** | Caso necessário, outros tópicos devem ser inseridos nesse arquivo.
**leites/** | Diretório com os leites dos períodos passados, separados por período (em seções do README.md ou em pastas). Preferencialmente, contém apenas provas e listas de exercícios.
**linksUteis.md** | Contém links de qualquer tipo de material que possa ser útil para estudar os assuntos da disciplina.
**visaoGeralEDicas.md** | Esse arquivo contém três seções: *Ementa*, uma lista dos tópicos formalmente abordados na disciplina, *Visão Geral*, uma breve descrição da disciplina e de sua importância para a carreira do cientista da computação, e *Dicas*, uma lista de dicas úteis para aqueles que irão começar a cursar a disciplina.

Para facilitar a criação dessa estrutura, você pode utilizar um *script* que disponibilizamos. Para usá-lo, basta ter Python instalado em sua máquina. Dito isso, navegue até a pasta [scripts](scripts/) em seu terminal:

```sh
cd scripts
```

E em seguida, execute o comando:

```sh
./create_folder_structure
```

Agora basta informar o nome da disciplina e a nova pasta será criada!


## Regras

- Respeite o código de conduta.
- Proibido publicar soluções de atividades avaliativas das disciplinas que se repetem todos os períodos, tais como os roteiros de LEDA e os laboratórios de LP2.
- Proibido falar mal dos professores. Evite, ao máximo, comentar opiniões pessoais de qualquer natureza sobre professores.
- Proibido publicar soluções de atividades avaliativas das disciplinas que se repetem todos os períodos, tais como os roteiros de LEDA e os laboratórios de LP2.


## Como contribuir

Leia o [CONTRIBUTING.md](CONTRIBUTING.md)!

É normal uma disciplina mude de metodologia ao longo do tempo. Se você notou alguma informação defasada, abra uma issue alertando-nos sobre o fato e, quem sabe, contribua para resolvermos o problema.


## Tambureteiros

[![](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/images/0)](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/links/0)[![](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/images/1)](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/links/1)[![](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/images/2)](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/links/2)[![](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/images/3)](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/links/3)[![](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/images/4)](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/links/4)[![](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/images/5)](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/links/5)[![](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/images/6)](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/links/6)[![](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/images/7)](https://sourcerer.io/fame/thayannevls/OpenDevUFCG/Tamburetei/links/7)

0 comments on commit fbd4e9b

Please sign in to comment.