coderacer/library
2
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity

Update readme.md

Browse source
This commit is contained in:
Dorian Zedler 2021-08-07 09:53:27 +00:00
parent e8817496d7
commit e502acdfdc
1 changed files with 36 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
readme.md
View file

@ -1,30 +1,36 @@
![Build Status](https://git.itsblue.de/Fenoglio/coderacer/badges/master/build.svg) ![Build Status](https://git.itsblue.de/Fenoglio/coderacer/badges/master/build.svg)
![Flyer](/Doku/Bilder/coderace_get_in_contact_pic.png) ![Flyer](/Doku/Bilder/coderace_get_in_contact_pic.png)
## Repo Overview ## Repo Overview
This is fun in progress and for sure not covering all questions and topics. This is fun in progress and for sure not covering all questions and topics.
Hopefully you will get an idea of what that project means and is able to do. Hopefully you will get an idea of what that project means and is able to do.
Have fun and let us know what you think. Have fun and let us know what you think.
Repo dir | Description Repo dir | Description
---------|-------------- ---------|--------------
Arduino/libraries | arduino stuff and libraries Arduino/libraries | arduino stuff and libraries
Doku | HowTo as well as doxygen documentation. View it [here](https://pages.itsblue.de/fenoglio/coderacer/) Doku | HowTo as well as doxygen documentation. View it [here](https://pages.itsblue.de/fenoglio/coderacer/)
Install | Everything to get your dev IDE running on your PC Install | Everything to get your dev IDE running on your PC
AppInventor | Module to load into AppInventor or directly to your phone. AppInventor | Module to load into AppInventor or directly to your phone.
Fritzing | Schematics and stuff Fritzing | Schematics and stuff
Bilder | Pictures of racers and events;-) Bilder | Pictures of racers and events;-)
## Full API Docs ## Full API Docs
A full API Documentation is available [here](https://pages.itsblue.de/fenoglio/coderacer/) A full API Documentation is available [here](https://pages.itsblue.de/fenoglio/coderacer/)
## How to start ## How to start
* Start reading the [{code}racer HowTo](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf) * Start reading the [{code}racer HowTo](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf)
* Learn about the [{code}racer API](https://pages.itsblue.de/fenoglio/coderacer/) * Learn about the [{code}racer API](https://pages.itsblue.de/fenoglio/coderacer/)
* Download the {code}racer Repo and install the IDE on your PC (see [CodeRacer HowTo Page.8](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf)) * Download the {code}racer Repo and install the IDE on your PC (see [CodeRacer HowTo Page.8](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf))
* Installation of used libraries (see [{code}racer HowTo Page.10](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf)) * Installation of used libraries (see [{code}racer HowTo Page.10](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf))
* Compile example (esp32_coderacer_beispiel) (see [{code}racer HowTo Page.11](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf)) * Compile example (esp32_coderacer_beispiel) (see [{code}racer HowTo Page.11](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf))
* Work on your OWN CodeRacer Algo * Work on your OWN CodeRacer Algo
## Feedback/Questions ## Feedback/Questions
* Please write your questions/feedback to development@itsblue.de * Please write your questions/feedback to development@itsblue.de
## Create a release
To create a release and publish it to the pio registry, follow these steps:
1. Increase the version number in `CodeRacer_MKII/library.json`
2. Commit and push
3. Create a git tag in the form of `vVERSION`, eg. `v1.0.5`
4. push git tags