From a55c672507dae7fef674c8da37bf6cae6f9bfc41 Mon Sep 17 00:00:00 2001 From: Vinicius Date: Sun, 10 Sep 2023 20:54:41 -0300 Subject: [PATCH] add readme --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++ docs/assets/logo.svg | 16 ++++++++++++++- 2 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0b4ae4e --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ + +
+ +Orna BR logo + +## Dorna + + +
+ + +## Sobre o Projeto + +**Dorna** é um site no estilo documentação que contém informações detalhadas sobre o jogo Orna RPG GPS. Neste repositório, você encontrará dicas, informações sobre edifícios, guias, atalhos e muito mais, tudo projetado para melhorar sua experiência no mundo de Orna. + +## Como Usar + +Você pode acessar a documentação em [Dorna](https://dorna.noxian.dev/), onde encontrará informações sobre: + +- Dicas para Iniciantes +- Descrições de Edifícios +- Guias +- Atalhos + +Além disso, você pode clonar este repositório para sua máquina local e gerar a documentação usando o Mkdocs e o tema Material: + +```bash +git clone https://github.com/Orna-Brasil/Dorna.git +cd dorna +pip install mkdocs mkdocs-material +mkdocs serve +``` + +Isso iniciará um servidor local que permite visualizar a documentação em seu navegador. + +## Contribuindo + +Agradecemos qualquer contribuição para melhorar esta documentação. Se você quiser adicionar informações, corrigir erros ou melhorar o layout, siga estas etapas: + +1. Faça um fork deste repositório. +2. Crie uma nova branch com uma descrição significativa: `git checkout -b sua-nova-feature`. +3. Faça suas alterações e documente-as adequadamente. +4. Envie suas alterações: `git push origin sua-nova-feature`. +5. Abra uma solicitação pull descrevendo suas alterações. + + +## Licença + +Este projeto está licenciado sob a [Licença MIT](LICENSE.md) - consulte o arquivo LICENSE.md para obter detalhes. \ No newline at end of file diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg index e4d5f92..8614e62 100644 --- a/docs/assets/logo.svg +++ b/docs/assets/logo.svg @@ -1 +1,15 @@ - \ No newline at end of file + + + + + + + + + + + + + + +