Skip to content

Commit 434fcd4

Browse files
committed
README.md: clean up and add "support" section
Break long lines to be <= 80 chars, where possible, and add a new section to guide users to the appropriate place for support (Arduino forum for product support, issue tracker for bugs & features).
1 parent eb0cf4f commit 434fcd4

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

README.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,44 @@ The contents of this repo is distributed through releases in Arduino IDE.
66
If you wish to use the latest **untested** changes, follow these instructions.
77

88
1. Install the latest `Intel Curie Boards by Intel` from `Boards Manager`
9-
2. Download the [latest snapshot](https://github.com/01org/corelibs-arduino101/archive/master.zip) of this repo
9+
2. Download the [latest snapshot](https://github.com/01org/corelibs-arduino101/archive/master.zip)
10+
of this repo
1011
3. Shut down the IDE
1112
4. Go to Arduino15 directory
1213
* Windows: `C:\Users\<user>\AppData\Roaming\Arduino15`
1314
* OS X: `~/Library/Arduino15`
1415
* Linux: `~/.arduino15`
1516
5. Go to `packages/Intel/hardware/arc32/<version>/`
16-
6. Delete the content of the directory from step 5, and replace it with the content of the "corelibs-arduino101-master" folder in the zip from step 2.
17+
6. Delete the content of the directory from step 5, and replace it with the
18+
content of the "corelibs-arduino101-master" folder in the zip from step 2.
1719

18-
Future upgrades may fail since the internal contents were modified by hand. In order to recover, shut down the IDE, delete the entire `Arduino15` directory, then restart the IDE.
20+
Future upgrades may fail since the internal contents were modified by hand. In
21+
order to recover, shut down the IDE, delete the entire `Arduino15` directory,
22+
then restart the IDE.
23+
24+
# Support & Issues
25+
26+
If you have found a bug, or you believe a new feature should be added, please
27+
use the Github issue tracker (click "Issues" above) to provide details about
28+
the bug or feature. If you need product support (e.g. have a question about /
29+
are having problems with the Arduino IDE or the Arduino API), please direct
30+
them to the [support forum](https://forum.arduino.cc/index.php?board=103).
31+
32+
## Examples of things that should go in the Issue tracker
33+
34+
> "I noticed that your DoSomeThing library doesn't support all the same
35+
> modes as the library from SomeOtherGuy: https://link-to-relevant-thing.com
36+
> Can you add support for these modes?"
37+
38+
> "If I run example sketch X on an Arduino 101 board, I get result Y. But if I
39+
> run the same sketch on an Arduino UNO board, I get result Z. This looks like
40+
> a bug to me."
41+
42+
## Examples of things that should go in the support forum
43+
44+
> "I'm having trouble downloading the Arduino 101 boards package in the Arduino
45+
> IDE Boards Manager"
46+
47+
> "How do I use this library?"
48+
49+
> "I can't get this example sketch to work. What am I doing wrong?"

0 commit comments

Comments
 (0)