Merge pull request #23 from ThundeRatz/develop

Atualização da documentação e adição da família G4

Makefile

@@ -44,6 +44,7 @@ ASM_SOURCES  := $(shell find $(CUBE_DIR) -name "*.s")
 C_SOURCES    := $(shell find src -name "*.c")
 C_HEADERS    := $(shell find inc -name "*.h")
 LIB_SOURCES  :=
+
 TEST_HEADERS := $(shell find $(TEST_DIR)/inc -name "*.h")
 TEST_SOURCES := $(shell find $(TEST_DIR)/src -name "*.c")
 
@@ -116,7 +117,7 @@ else ifeq ($(DEVICE_FAMILY), $(filter $(DEVICE_FAMILY),STM32L0xx STM32G0xx))
 MCUFLAGS += -mcpu=cortex-m0plus
 else ifeq ($(DEVICE_FAMILY), $(filter $(DEVICE_FAMILY),STM32F1xx STM32L1xx STM32F2xx STM32L2xx))
 MCUFLAGS += -mcpu=cortex-m3
-else ifeq ($(DEVICE_FAMILY), $(filter $(DEVICE_FAMILY),STM32F3xx STM32L3xx STM32F4xx STM32L4xx STM32WBxx))
+else ifeq ($(DEVICE_FAMILY), $(filter $(DEVICE_FAMILY),STM32F3xx STM32L3xx STM32F4xx STM32L4xx STM32WBxx STM32G4xx))
 MCUFLAGS += -mcpu=cortex-m4 -mfpu=fpv4-sp-d16 -mfloat-abi=hard
 else ifeq ($(DEVICE_FAMILY), $(filter $(DEVICE_FAMILY),STM32F7xx STM32L7xx))
 MCUFLAGS += -mcpu=cortex-m7 -mfpu=fpv4-sp-d16 -mfloat-abi=hard
@@ -335,7 +336,7 @@ help:
 	@echo
 	@echo "Opcoes:"
 	@echo "	help:       mostra essa ajuda"
-	@echo "	cube:       gera arquivos do cube (não funciona no momento por limitações no cube)"
+	@echo "	cube:       gera arquivos do cube"
 	@echo "	prepare:    prepara para compilação inicial apagando arquivos do cube"
 	@echo "	all:        compila todos os arquivos"
 	@echo "	info:       mostra informações sobre o uC conectado"

README.md

@@ -61,7 +61,7 @@ Com o arquivo do projeto na pasta correta, os seguintes comandos devem ser
 executados (necessário apenas após dar checkout no repositório ou mudar o cube):
 
 ```bash
-make cube     # Gera arquivos do cube (não funciona no momento por limitações no cube)
+make cube     # Gera arquivos do cube
 make prepare  # Apaga os arquivos do cube desnecessários e gera arquivos de configuração do VS Code
 ```
 
@@ -113,9 +113,16 @@ LIB_DIR  := lib
 # Cube Directory
 CUBE_DIR := cube
 
+# Config Files Directory
+CFG_DIR :=
+
+# Tests Directory
+TEST_DIR := tests
+
 # Default values, can be set on the command line or here
 DEBUG   ?= 1
 VERBOSE ?= 0
+TEST    ?= 0
 ```
 
 ## Compilando
@@ -167,7 +174,9 @@ opções da lista para executar os comandos de compilação e gravação mais ra
 * Flash Program (_make flash_)
 * Build and Flash (_make && make flash_)
 
-## Adicionando um submódulo
+## Submódulos
+
+### Adicionando um submódulo
 
 Crie um diretório chamado `lib` e adicione o submódulo nele.
 
@@ -178,6 +187,28 @@ mkdir lib
 git submodule add --name STMSensors [email protected]:ThundeRatz/STMSensors.git lib/STMSensors
 ```
 
+### Inicializando um submódulo já existente
+
+Ao clonar um repositório que já tem submódulos, é necessário clonar os repositórios desse submódulo. Isso pode ser feito de duas formas, clonando junto com o repositório do projeto ou depois de já ter clonado.
+
+Exemplo:
+
+Para se clonar junto, deve-se fazer:
+
+```bash
+git clone --recurse-submodules [email protected]:ThundeRatz/STM32ProjectTemplate.git
+```
+
+Para se clonar depois de já ter clonado o repositório do projeto:
+
+```bash
+git submodule update --init
+```
+
+## Diretório de testes
+
+O diretório definido pela variável `TEST_DIR` contém arquivos para testes de partes específicas do projeto, separando isso do código do proejto em si. Esses arquivos devem ser implementados de acordo com as necessidades dos desenvolvedores. O diretório contém uma função `main()` própria. Para se fazer os testes com esses arquivos, compilá-los e gravar o executável gerado, deve-se mudar o valor da variável `TEST` para 1.
+
 ## Debug
 
 > Em breve

src/mcu.c

@@ -10,7 +10,6 @@
 
 #include "gpio.h"
 #include "main.h"
-#include "stm32f3xx_hal.h"
 
 /*****************************************
  * Public Function Body Definitions