Skip to content

Commit 81c4244

Browse files
committed
Merge pull request #5 from per1234/update-doc
Fix typos and improve documentation
2 parents fd61799 + 09f43de commit 81c4244

File tree

4 files changed

+13
-12
lines changed

4 files changed

+13
-12
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@ This bootloader loads a file from the SD card on startup. This documentation is
55

66

77
## Installation
8+
There are two options for installing **avr_boot** boards in the Arduino IDE:
89
#### Boards Manager Installation(requires Arduino IDE version 1.6.4 or greater)
910
- Open the Arduino IDE.
1011
- Open the **File > Preferences** menu item.
1112
- Enter the following URL in **Additional Boards Manager URLs**: https://zevero.github.io/avr_boot/package_zevero_avr_boot_index.json
1213
- Open the **Tools > Board > Boards Manager...** menu item.
1314
- Wait for the platform indexes to finish downloading.
1415
- Scroll down until you see the **avr_boot** entry and click on it.
15-
- If you are using Arduino IDE 1.6.6 then you may need to close **Boards Manager** and then reopen it before the **Ariadne Bootloader** entry will appear.
16+
- **Note**: If you are using Arduino IDE 1.6.6 you may need to close **Boards Manager** and then reopen it before the **avr_boot** entry will appear.
1617
- Click **Install**.
1718
- After installation is complete close the **Boards Manager** window.
1819

@@ -24,7 +25,7 @@ This bootloader loads a file from the SD card on startup. This documentation is
2425

2526
<a id="menus"></a>
2627
## Using the Board Menu Entries
27-
After installing Ariadne several new boards are added to the **avr_boot** section of the **Tools** > **Board** menu. When any of these boards are selected additional menus will appear under the **Tools** menu.
28+
After installing avr_boot several new boards are added to the **avr_boot** section of the **Tools** > **Board** menu. When any of these boards are selected additional menus will appear under the **Tools** menu.
2829

2930
Whenever you change a setting in these menus you need to **[Burn Bootloader](#burn)** to reconfigure your board.
3031

@@ -38,23 +39,23 @@ Displays a list of board models for your **Board** menu selection.
3839
The SD CS pin may be connected to different Arduino pins depending on which shield you are using.
3940
- Ethernet Shield: 4
4041
- Arduino Ethernet: 4
41-
- Seeed SD card shield: Pin 4
42-
- Adafruit Data Logger Shield: Pin 10
43-
- Sparkfun MicroSD Shield: Pin 8
42+
- Seeed SD card shield: 4
43+
- Sparkfun MicroSD Shield: 8
44+
- Adafruit Data Logger Shield: 10
4445

4546
#### Clock Menu
46-
- **16MHz Low Power** - This is usually the best setting to use for commercially produced boards that run at 16MHz.
47-
- **16MHz Full Swing** - This setting can be used for breadboard or homemade 16MHz boards where the low power setting is unreliable due to electrical interference.
47+
- **16MHz Low Power** - This is usually the best setting to use for commercially produced boards that run at 16MHz as it will decrease power usage compared to the **16MHz Full Swing** setting.
48+
- **16MHz Full Swing** - This setting can be used for breadboard or homemade 16MHz boards where the **16MHz Low Power** setting causes unreliability due to electrical interference.
4849
- **20MHz** - If your board has a 20MHz crystal this is the one for you.
4950
- **8MHz Internal** - For boards without an external 16MHz crystal or to reduce power consumption.
5051

5152
#### Pinout Menu(ATmega1284P only)
52-
The default **ATmega1284P** Board uses the **[avr_developers](https://github.com/JChristensen/mighty-1284p/blob/v1.6.3/avr/variants/avr_developers/pins_arduino.h)** pinout, additional ATmega1284P pinouts are available for compatibility with other ATmega1284P based boards but **[Mighty 1284P](https://github.com/JChristensen/mighty-1284p/tree/v1.6.3)** must be installed to use them.
53+
The default **ATmega1284P** Board uses the **[avr_developers](https://github.com/JChristensen/mighty-1284p/blob/v1.6.3/avr/variants/avr_developers/pins_arduino.h)** pinout. Additional ATmega1284P pinouts are available for compatibility with other ATmega1284P based boards but you must install **[Mighty 1284P](https://github.com/JChristensen/mighty-1284p/tree/v1.6.3)** to use them.
5354

5455

5556
<a id="burn"></a>
5657
## Burning the Bootloader
57-
To burn the bootloader, you will need an ISP(in-system programmer). After you have connected the Arduino board and the programmer to your computer navigate to the **Tools** > **Board** menu and select the correct board. Then go to **Tools** > **Programmer** and select the programmer you are using. In case you are using **Arduino as ISP**, make sure that the selected port in the **Tools** > **Serial Port** menu refers to the **Arduino as ISP** and not the board that you want to burn the bootloader on. Now, just launch the **Tools** > **Burn Bootloader** command and wait until the operation completes. You will no longer be able to upload sketches to your board using USB once the avr_boot bootloader is installed. To go back to normal uploading repeat the bootloader burning process with a non-avr_boot board selected.
58+
To burn the bootloader, you will need an ISP(in-system programmer). After you have connected the Arduino board and the programmer to your computer navigate to the **Tools** > **Board** menu and select the correct board. Then go to **Tools** > **Programmer** and select the programmer you are using. In case you are using **Arduino as ISP**, make sure that the selected port in the **Tools** > **Serial Port** menu refers to the **Arduino as ISP** board and not the board that you want to burn the bootloader on. Now, just launch the **Tools** > **Burn Bootloader** command and wait until the operation completes. You will no longer be able to upload sketches to your board using USB once the avr_boot bootloader is installed. To go back to normal uploading repeat the bootloader burning process with a non-avr_boot board selected.
5859

5960

6061
<a id="upload"></a>
@@ -64,6 +65,6 @@ See the **Compile and put your sketch on SD Card** instructions **[here](https:/
6465

6566
<a id="acknowledgements"></a>
6667
## Acknowledgements
67-
- [Mighty 1284P](https://github.com/JChristensen/mighty-1284p) - ATmega1284P support
6868
- [David A. Mellis](https://github.com/damellis) - avr_developers variant for ATmega1284P
69+
- [Mighty 1284P](https://github.com/JChristensen/mighty-1284p) - ATmega1284P support
6970
- [Others listed in the main documentation](https://github.com/zevero/avr_boot)

avr_boot_1.1.0.tar.gz

55 Bytes
Binary file not shown.

avr_boot_manualinstall_1.1.0.zip

56 Bytes
Binary file not shown.

package_zevero_avr_boot_index.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
},
2020
"url": "https://zevero.github.io/avr_boot/avr_boot_1.1.0.tar.gz",
2121
"archiveFileName": "avr_boot_1.1.0.tar.gz",
22-
"checksum": "SHA-256:d9c1bf38ded98703870a7f7f706ef48c26c241be3b842075e449bbfdcb9d620a",
23-
"size": "16627",
22+
"checksum": "SHA-256:5f0f67942d1da5284192c8dbceae855d0bb8b26ae10281013f7862aaac6771f0",
23+
"size": "16682",
2424
"boards": [
2525
{"name": "ATmega328P"},
2626
{"name": "ATmega32U4"},

0 commit comments

Comments
 (0)