Skip to content
This repository was archived by the owner on Feb 21, 2020. It is now read-only.

Commit 3989ed3

Browse files
committed
added README.md
1 parent 80c347d commit 3989ed3

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Arduino Core for STM32F4 CPU
2+
3+
This repository contains the source code and configuration files of the Arduino Core
4+
for ST Microelectronics STM32F4 processor (used on the Arduino STAR OTTO).
5+
6+
## Installation on Arduino IDE
7+
8+
This core is available as a package in the Arduino IDE cores manager.
9+
Just open the "Boards Manager" and install the package called:
10+
11+
"Arduino STM32F4 Boards (32-bit ARM Cortex-M4)"
12+
13+
## Support
14+
15+
There is a dedicated section of the Arduino Forum for general discussion and project assistance:
16+
17+
http://forum.arduino.org/index.php?board=98.0
18+
19+
## Bugs or Issues
20+
21+
If you find a bug you can submit an issue here on github:
22+
23+
https://github.com/arduino/Arduino-core-stm32f4/issues
24+
25+
Before posting a new issue, please check if the same problem has been already reported by someone else
26+
to avoid duplicates.
27+
28+
## Contributions
29+
30+
Contributions are always welcome. The preferred way to receive code cotribution is by submitting a
31+
Pull Request on github.
32+
33+
## Hourly builds
34+
35+
This repository is under a Continuous Integration system that every hour checks if there are updates and
36+
builds a release for testing (the so called "Hourly builds").
37+
38+
The hourly builds are available through Boards Manager. If you want to install them:
39+
1. Open the **Preferences** of the Arduino IDE.
40+
2. Add this URL `http://downloads.arduino.cc/Hourly/STM32F4/package_stm32f4-hourly-build_index.json` in the **Additional Boards Manager URLs** field, and click OK.
41+
3. Open the **Boards Manager** (menu Tools->Board->Board Manager...)
42+
4. Install **Arduino STM32F4 core - Hourly build**
43+
5. Select one of the boards under **STM32F4 Hourly build XX** in Tools->Board menu
44+
6. Compile/Upload as usual
45+
46+
If you already installed an hourly build and you want to update it with the latest:
47+
1. Open the **Boards Manager** (menu Tools->Board->Board Manager...)
48+
2. Remove **Arduino SAMD core - Hourly build**
49+
3. Install again **Arduino SAMD core - Hourly build**, the Board Manager will download the latest build replacing the old one.
50+
51+
## License and credits
52+
53+
This core has been developed by Arduino.org in collaboration with STM.
54+
55+
```
56+
Copyright (c) 2017 Arduino.org All right reserved.
57+
58+
This library is free software; you can redistribute it and/or
59+
modify it under the terms of the GNU Lesser General Public
60+
License as published by the Free Software Foundation; either
61+
version 2.1 of the License, or (at your option) any later version.
62+
63+
This library is distributed in the hope that it will be useful,
64+
but WITHOUT ANY WARRANTY; without even the implied warranty of
65+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
66+
See the GNU Lesser General Public License for more details.
67+
68+
You should have received a copy of the GNU Lesser General Public
69+
License along with this library; if not, write to the Free Software
70+
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

0 commit comments

Comments
 (0)