diff --git a/README.md b/README.md index f02cce5..d60f856 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,3 @@ Produto Tecnológico desenvolvido durante projeto de Mestrado "Novo framework baseado em Python para processamento de biossinais" do Programa em Engenharia Elétrica e Informática Industrial (CPGEI) da UTFPR - Campus Curitiba, sob orientação dos professores Dr. José Jair Alves Mendes Júnior e Dr. Daniel Prado de Campos. -# Como Gerar Uma Nova Documentação - -1. Pelo terminal entre na pasta onde está localizado o projeto OpenBCI_Python_Framework -2. Inicie um virtual enviroment de python. Se você não possuir o pacote venv do python - instalado globalmente no seu PC você pode rodar o seguinte comando:
- Linux:
- ``` - python3 -m venv venv - ``` - Windows:
- ``` - py -m venv env - ``` -3. Entre no ambiente virtual do python do projeto:
- Linux:
- ``` - source venv/bin/activate - ``` - Windows:
- ``` - .\venv\Scripts\activate - ``` -4. Instale as bibliotecas do projeto:
- Linux/Windows:
- ``` - pip install -r requirements.txt - ``` -5. Execute o seguinte comando no terminal:
- ``` - sphinx-apidoc -o docs . - ``` -6. Entre no diretório docs: - ``` - cd ./docs - ``` -7. Crie o html : - ``` - make html - ``` - -O novo html será gerado. Agora basta abrir o arquivo "OpenBCI_Python_Framework-main/docs/_build/html/index.html" no seu navergador. \ No newline at end of file +Documentação: [https://arthurhauer.github.io/OpenBCI_Python_Framework/](https://arthurhauer.github.io/OpenBCI_Python_Framework/)