DisplayESP32/Readme.md

# Readme

# Basic Instructions of Repository DisplayESP32

**This repository aims to provide some functions for creating a user interface for the display Adafruit SSD1306 on microcontroller ESP32**


## To begin with

To be able to use this repository, it's important to first connect the display to the microcontroller, the following diagram shows the way it should be done when using an ESP32-WROOM board.
*Considers that the Wiki page is not considered by the git system*.



## Projects and Issues tab 

To organize your progress, use the issues and projects tabs. In this way, it is possible to schedule your tasks and set milestones. Thus, each week can start by reviewing the pending tasks, organize your week tasks, and at the end of the week check and mark your progress.

### Issues and Labels

Let us start by setting some milestones (proposal, prototype, software function, etc.), set a Due Date, and its description. With your milestones, it will be easy to organize issues and track your progress.

After defining a milestone, 


- **task**
- **bug** 
- **improve**
- **

The `git-template` includes 9 basic labels to use each time you create an issue. These labels are detailed next:

- bug: Somethign is not working as expected or getting wrong results 
- duplicated: This issue or pull request already exists 
- further work: General advices to be considered in future elements, projects or submodules 
- help wanted: Some help is required by supervisors; directions, raw material, material, review results, or laboratory assistance 
- improve: Something has to be improved or rebuiled to improve expected results 
- question: Something needs a fast review or guidance to focus the aim of the project 
- submodules: The project should considers to create a submodule element to integrate in this project
- task: Assigned task to complete a milestone or project element; the assigned collaborators have to complete the task 
- wiki: Elements or information to be included in the Wiki page 

### Projects
**Considers that this is the main repository. Thus, create projects for main elements (circuit stage, specific behaivior, component, document, simulation, or submodule, etc.) to manage components or submodules related with the main repository**.

In the project always create three main boards: Todo, In Progress and Done.