Commit 8375b2d4 authored by Pedro Henrique Kopper's avatar Pedro Henrique Kopper

Melhorar documentaçao

parent 9f13b65c
......@@ -4,13 +4,49 @@ Este software é uma reescrita da interface do SADAPMAP para uso nos processamen
Ele visa ter um código mais limpo, porém menos genérico, e ser base para futuros desenvolvimentos no SADAPMAP.
A ideia é ter bases de código separadas para o SACADA e para o SADAPMAP, visto que seus objetivos muitas vezes conflitam e acabam
levando a soluções inadequadas pros problemas, vide a interface e seu código spaghetti.
levando a soluções inadequadas pros problemas, vide a interface e seu código spaghetti. Pode servir de inspiração para uma eventual reescrita da interface de calibração.
# Instalação
![Software rodando](resources/print.png)
---
## Instalação
Assim como o software original, este software também faz uso do pipenv, ferramenta padrão de ambientes virtuais do Python3. Ela pode ser encontrada no pacote `python3-pip` na maioria das distribuições. É importante frisar que este software suporta _apenas_ Python 3.
Ao clonar o repositório, basta rodar `pipenv install` para baixar e instalar as dependências automaticamente.
### Instalação
Para instalar o software, é necessário ter os pacotes `git` e `pipenv` instalados. A partir daí, você pode
clonar o repositório para uma pasta local
```bash
git clone https://git.cta.if.ufrgs.br/SADAPMAP/Processamento.git
```
e instalar as dependências
```bash
cd Processamento
pipenv install
```
para rodar, use
```bash
pipenv run python3 Processamento.py
```
### Estrutura do projeto
`resources`: Recursos auxiliares ao desenvolvimento do programa. Imagens, textos, arquivos de configuração de UI etc
`ui`: Guarda o código relativo à interface de usuário. Alguns deles são gerados por computador e não devem ser editados.
`util`: Guarda funções/classes miscelâneas que são úteis mas não se encaixam em mais nenhuma categoria.
---
## Desenvolvimento
[TODO]
---
# Licença
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment