Skip to content

Commit

Permalink
Update "install" instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
WestfW committed Sep 26, 2016
1 parent 814e2a8 commit 0eb5e37
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,29 @@ Optiboot is now installed by default on the Arduino Uno. It can be installed on
## Additional Documentation
More detailed documentation is being added (slowly) to the [repository wiki](https://github.com/Optiboot/optiboot/wiki).

## Notes on IDE Version compatability
Optiboot in "compatible", it a loose sense, will all versions of the Arduino IDE. It was originally written at about the same time as v1.0, and has some "quirks" that date back to that timeframe. Most significantly, install procedures and locations change between releases, and the ability to compile optiboot using only the tools installed with the IDE broke in the v1.5 timeframe.

## To install into the Arduino software ##
You do NOT need to "install" Optiboot if you are trying to update an installed platform that already uses some form of Optiboot. In that case, you should probably just find and replace the existing .hex files from the platform support directories. Using the optiboot "install" procedure does not install any cores or variants, so it is only useful for cpus that are already supported by the standard Arduino core. (or, if all you want to do is install bootloaders.)

The following instructions are based on using the Arduino "Board Manager", present in IDE versions 1.6.5 and later.

1. Find the desired Optiboot release on the [Optiboot Rlease page] (https://github.com/Optiboot/optiboot/releases).
2. Use the "Copy Link" feature of your browswer copy the URL of the associated **.json** file.
3. Paste this url into the "Additional Boards Manager URLs" field in the Arduino IDE "Preferences" pane. (Separate it from other URLs that might be present with a comma.)
4. After closing the preferences pain, the **Tools/Boards/Boards Manager** menu should include an entry for that version of Optiboot. Select that entry and click the **Install** button.

For addition installation information, see the [Optiboot AddingOptibootChipsToIde Wiki page] (https://github.com/Optiboot/optiboot/wiki/AddingOptibootChipsToIde)


<!---
1. Download the latest using Git or the Zip download feature of GitHub. If you download as a zip, also extract it.
1. You will need to be using a recent version of the [Arduino environment](http://arduino.cc), version 18 or later.
1. Create a 'hardware' directory inside your sketches folder.
1. Copy the optiboot directory into the hardware directory.
1. Restart the Arduino software. New boards will appear in the Tools>Board menu.
--->

## To burn Optiboot onto an Arduino board ##
1. Select the appropriate Optiboot board type (or non-Optiboot if you want to change back)
Expand Down

0 comments on commit 0eb5e37

Please sign in to comment.