Skip to content

Commit bc4f797

Browse files
authoredJul 1, 2019
Move installation to top
1 parent 3d19282 commit bc4f797

File tree

1 file changed

+27
-25
lines changed

1 file changed

+27
-25
lines changed
 

‎README.md

+27-25
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,38 @@
33

44
## Contents
55

6-
* [Development Status]()
76
* [Installation]()
7+
* [Development Status]()
88
* [Issue Template]()
99
* [Repo Contents]()
1010
* [Acknowledgements]()
1111

12+
13+
## Installation
14+
15+
The structure of this repo is such that it will most closely resemble the structure required when it is time to add it to the Arduino boards manager. Until then you'll have to use the manual installation process.
16+
17+
* [Using Arduino IDE Boards Manager](https://github.com/sparkfun/Arduino_Boards) (Reccomended)
18+
* Follow the instructions at the [SparkFun Arduino Boards Repo](https://github.com/sparkfun/Arduino_Boards)
19+
* Open 'Boards Manager' and select 'SparkFun Apollo3 Boards,' install the latest version.
20+
* JSON boards manager link for convenience: https://raw.githubusercontent.com/sparkfun/Arduino_Boards/master/IDE_Board_Manager/package_sparkfun_index.json
21+
22+
23+
* [Manually Install in Arduino Sketchbook]()
24+
* **First** Install the Arduino SAMD Boards through the Arduino Board Manager. This is required for the ARM Cortex-M toolchain.
25+
* Open your Arduno sketchbook folder, listed in Arduino's preferences pane (it is where your libraries folder lives)
26+
* If there is no ```hardware``` folder create it
27+
* Inside the ```hardware``` folder create ```SparkFun```
28+
* Choose to clone with Git or download the .zip of this repo
29+
* Cloning
30+
* Clone this repo into ```SparkFun``` and give it the name ```apollo3```
31+
* .ZIP
32+
* Download the .ZIP of this repository
33+
* Within ```SparkFun``` create the ```apollo3``` directory
34+
* Unzip the contents of the .ZIP into the ```apollo3``` directory
35+
* Restart Arduino IDE for good measure
36+
37+
1238
## Development Status
1339

1440
The basic necesseties are in-place. This means that you can compile and upload code to your Apollo3 board. Development can be done with the whole range of Hardware Abstraction Layer functions provided in the AmbiqSuite Software Development Kit (based on Release2.1.0).
@@ -35,30 +61,6 @@ Current focus is to begin building support for the essential Arduino libraries i
3561
* Working: transfers with SPISettings.
3662

3763

38-
## Installation
39-
40-
41-
The structure of this repo is such that it will most closely resemble the structure required when it is time to add it to the Arduino boards manager. Until then you'll have to use the manual installation process.
42-
43-
* [Using Arduino IDE Boards Manager](https://github.com/sparkfun/Arduino_Boards) (Reccomended)
44-
* Follow the instructions at the [SparkFun Arduino Boards Repo](https://github.com/sparkfun/Arduino_Boards)
45-
* Open 'Boards Manager' and select 'SparkFun Apollo3 Boards,' install the latest version.
46-
* JSON boards manager link for convenience: https://raw.githubusercontent.com/sparkfun/Arduino_Boards/master/IDE_Board_Manager/package_sparkfun_index.json
47-
48-
49-
* [Manually Install in Arduino Sketchbook]()
50-
* **First** Install the Arduino SAMD Boards through the Arduino Board Manager. This is required for the ARM Cortex-M toolchain.
51-
* Open your Arduno sketchbook folder, listed in Arduino's preferences pane (it is where your libraries folder lives)
52-
* If there is no ```hardware``` folder create it
53-
* Inside the ```hardware``` folder create ```SparkFun```
54-
* Choose to clone with Git or download the .zip of this repo
55-
* Cloning
56-
* Clone this repo into ```SparkFun``` and give it the name ```apollo3```
57-
* .ZIP
58-
* Download the .ZIP of this repository
59-
* Within ```SparkFun``` create the ```apollo3``` directory
60-
* Unzip the contents of the .ZIP into the ```apollo3``` directory
61-
* Restart Arduino IDE for good measure
6264

6365
## How to Contribute
6466
The goal of this Arduino Core is to provide excellent Apollo3 support in a clear and extendable manner. The guidelines for contributing and submitting issues are designed to make it easy to integrate work from many people.

0 commit comments

Comments
 (0)
Please sign in to comment.