Merge pull request #3 from Luidooo/main

README

PT/README.md

@@ -0,0 +1,50 @@
+# EdraDocs
+
+[Documentação em Inglês](../README.md)
+
+## Documentação Oficial da Área de Equipe de Robótica (EDRA) na Universidade de Brasília
+
+## Como executar?
+```bash
+git clone https://github.com/edra-unb-fga/EdraDocs.git
+```
+```bash
+pip install mkdocs-material
+```
+```bash
+mkdocs serve
+```
+em seguida, acesse http://127.0.0.1:8000/
+
+# Como contribuir?
+
+1. Faça um Fork do Repositório: Clique no botão "Fork" no canto superior direito da página do repositório no GitHub. Isso criará uma cópia do repositório em sua conta do GitHub.
+
+2. Clone o Repositório Forkado: Clone o repositório forkado para sua máquina local usando o comando git clone seguido pela URL do seu fork. Por exemplo:
+```bash
+git clone https://github.com/edra-unb-fga/EdraDocs.git
+```
+3. Crie um Novo Branch: Crie um novo branch para trabalhar em suas alterações. Use um nome descritivo para seu branch que reflita as mudanças que você está fazendo. Por exemplo:
+```bash
+git checkout -b feature/new-feature
+```
+4. Faça Alterações: Faça as alterações desejadas no código usando seu editor de texto ou IDE preferido.
+
+5. Comite as Alterações: Assim que você fizer suas alterações, comite-as para seu repositório local usando o comando 'git commit'. Certifique-se de fornecer uma mensagem de commit significativa que descreva as alterações que você fez. Por exemplo:
+```bash
+git add .
+```
+```bash
+git commit -m "Add new feature"
+```
+6. Envie as Alterações: Envie suas alterações para seu repositório forkado no GitHub usando o comando 'git push'. Por exemplo:
+```bash
+git push origin feature/new-feature
+```
+7. Crie um Pull Request: Vá para a página do GitHub do seu repositório forkado e clique no botão "New pull request". Compare as alterações entre seu branch e o branch principal do repositório original. Forneça um título e descrição descritivos para o seu pull request, explicando as alterações que você fez.
+
+8. Revisão e Discussão: Após criar o pull request, outros colaboradores ou mantenedores podem revisar suas alterações e fornecer feedback. Esteja receptivo a quaisquer comentários ou sugestões feitas.
+
+9. Aborde o Feedback (Se Necessário): Se feedback for fornecido, faça quaisquer alterações necessárias em seu código com base no feedback recebido. Comite e envie as alterações para seu branch.
+
+10. Mescle o Pull Request: Uma vez que seu pull request tenha sido aprovado e todas as discussões tenham sido resolvidas, um mantenedor do repositório original mesclará suas alterações no branch principal.

README.md

@@ -1 +1,55 @@
-# EdraDocs
+# EdraDocs
+
+[Portuguese Documentation](./PT)
+
+## Official Documentation of the Robotics Team Area (EDRA) at the University of Brasilia
+
+## How to run?
+```bash
+git clone https://github.com/edra-unb-fga/EdraDocs.git
+```
+```bash
+pip install mkdocs-material
+```
+```bash
+mkdocs serve
+```
+than enter on http://127.0.0.1:8000/
+
+## How to Contribute?
+
+1. Fork the Repository: Click on the "Fork" button in the top-right corner of the repository's GitHub page. This will create a copy of the repository in your GitHub account.
+
+2. Clone the Forked Repository: Clone the forked repository to your local machine using the git clone command followed by the URL of your fork. For example:
+```bash
+git clone https://github.com/edra-unb-fga/EdraDocs.git
+```
+3. Create a New Branch: Create a new branch to work on your changes. Use a descriptive name for your branch that reflects the changes you're making. For example:
+```bash
+git checkout -b feature/new-feature
+```
+4. Make Changes: Make your desired changes to the codebase using your preferred text editor or IDE.
+
+5. Commit Changes: Once you've made your changes, commit them to your local repository using the git commit command. Be sure to provide a meaningful commit message that describes the changes you've made. For example:
+
+```bash
+git add .
+```
+```bash
+git commit -m "Add new feature"
+```
+6. Push Changes: Push your changes to your forked repository on GitHub using the git push command. For example:
+```bash
+git push origin feature/new-feature
+```
+
+7. Create a Pull Request: Go to the GitHub page of your forked repository and click on the "New pull request" button. Compare the changes between your branch and the original repository's main branch. Provide a descriptive title and description for your pull request, explaining the changes you've made.
+
+8. Review and Discuss: After creating the pull request, other contributors or maintainers may review your changes and provide feedback. Be responsive to any comments or suggestions that are made.
+
+9. Address Feedback (If Necessary): If feedback is provided, make any necessary changes to your code based on the feedback received. Commit and push the changes to your branch.
+
+10. Merge Pull Request: Once your pull request has been approved and all discussions have been resolved, a maintainer of the original repository will merge your changes into the main branch.
+
+
+