From db5c91157932e04103751c3f65a5d99bf04a0c47 Mon Sep 17 00:00:00 2001 From: Leonardo Date: Fri, 14 Jul 2023 18:16:33 -0300 Subject: [PATCH] Update instructions for build and controller implementation --- instructions/README_EN.md | 28 ++++++++++++++++++++++++++++ instructions/README_PTBR.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+) diff --git a/instructions/README_EN.md b/instructions/README_EN.md index 4285fd9..385fb74 100644 --- a/instructions/README_EN.md +++ b/instructions/README_EN.md @@ -27,6 +27,34 @@ Para enviar o seu código compilado para a placa, conecte a placa pelo cabo USB pio run -e ic2d-release -t upload ``` +Após ter uma versão estável do seu código (testada e validada) você pode submeter a PR pelo GitHub para que suas alterações sejam incluídas nesse repositório. + +### Criando um controlador novo + +Confira se o controle que você precisa já existe [aqui](/lib/forecastnucleoframework/src/controllers/). Os caminhos de pasta descritos nessa seção são relativos a pasta raiz do seu repositório. Crie novos arquivos de cabeçalho e código fonte (.hpp e .cpp) nas respectivas pastas: + +```bash +lib/forecastnucleoframework/include/forecast/controllers +``` + +```bash +lib/forecastnucleoframework/src/controllers +``` + +Seu novo controlador precisa ser incluído no arquivo [src/main.cpp](/src/main.cpp): + +``` +/** Controllers Headers */ +#include +//... +#include +``` + +E dentro da função __main__: +``` +app.get_controller_factory().add("Nome do Controlador", make_nome_controle_builder()); +``` + ## Usuário avançado: entendendo as dependências do framework e fazendo alterações nelas Primeiramente, espero que você saiba o que esta fazendo. Segundamente, boa sorte! Esse framework baseado em Platformio foi originalmente desenvolvido com: diff --git a/instructions/README_PTBR.md b/instructions/README_PTBR.md index 4285fd9..385fb74 100644 --- a/instructions/README_PTBR.md +++ b/instructions/README_PTBR.md @@ -27,6 +27,34 @@ Para enviar o seu código compilado para a placa, conecte a placa pelo cabo USB pio run -e ic2d-release -t upload ``` +Após ter uma versão estável do seu código (testada e validada) você pode submeter a PR pelo GitHub para que suas alterações sejam incluídas nesse repositório. + +### Criando um controlador novo + +Confira se o controle que você precisa já existe [aqui](/lib/forecastnucleoframework/src/controllers/). Os caminhos de pasta descritos nessa seção são relativos a pasta raiz do seu repositório. Crie novos arquivos de cabeçalho e código fonte (.hpp e .cpp) nas respectivas pastas: + +```bash +lib/forecastnucleoframework/include/forecast/controllers +``` + +```bash +lib/forecastnucleoframework/src/controllers +``` + +Seu novo controlador precisa ser incluído no arquivo [src/main.cpp](/src/main.cpp): + +``` +/** Controllers Headers */ +#include +//... +#include +``` + +E dentro da função __main__: +``` +app.get_controller_factory().add("Nome do Controlador", make_nome_controle_builder()); +``` + ## Usuário avançado: entendendo as dependências do framework e fazendo alterações nelas Primeiramente, espero que você saiba o que esta fazendo. Segundamente, boa sorte! Esse framework baseado em Platformio foi originalmente desenvolvido com: