diff --git a/README.md b/README.md index 8ee978e..0974b3d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ -# STM32F4-with-EmBitz -Projects with stm32f4 - discovery with EmBitz +# STM32F4 with EmBitz + +This repo is a guide to start developing projects with STM32F3 Discovery board and EmBitz IDE. +Using the standart libraries, there ares examples how to configure and use the peripherals in a easy way. Probably this examples could be applied to others ARM microcontrolers. +Enjoy it :) + +## Pre-requisites + +* Install EmBitz from the official page https://www.embitz.org/ +* STM32F4 Discovery board (or other stm32F4 microcontroller) + +## Getting Started + +### New project + +``` +If you want, you can just use the StartProject and skip this step +``` + +File-> New Project -> choose stm32f429zi (the microcontroller used on discovery board). +Make sure you select the standart peripheral library! + +### Write on microcontroller + +When everything is done, you can click on debug button to compile the code and programing the microncontroller. If is everything ok EmBitz will open a new file (in assembely), ignore it for now. Click on Continue and you will see your code working on. + +## Contributing + +Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. + +## Authors + +* **Daniel Oliveira** - [OhMeuMenino](https://github.com/OhMeuMenino) + +See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details