Skip to content

Commit 4bb465d

Browse files
committed
Update readme
1 parent cd6fe5e commit 4bb465d

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

README.MD

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ An mbed-os enabled Arduino core for Ambiq Apollo3 based boards
99
- [Installation](#installation)
1010
- [**Arduino Boards Manager** (recommended)](#arduino-boards-manager-recommended)
1111
- [**Git** (development)](#git-development)
12+
- [Getting Started](#getting-started)
1213
- [Development Status](#development-status)
1314
- [Priorities](#priorities)
1415
- [More](#more)
@@ -26,14 +27,33 @@ An mbed-os enabled Arduino core for Ambiq Apollo3 based boards
2627

2728
### **Git** (development)
2829
- Ensure the proper directory structure exists by following the [Arduino Boards Manager](#arduino-boards-manager) instructions (install latest)
29-
- Locate and enter the ```Arduino15``` directory
30-
- ```cd ~/.../Arduino15```
31-
- Run the ```dev-install.sh``` script
32-
- ```./packages/SparkFun/hardware/apollo3/*/tools/scripts/dev-install.sh```
30+
- navigate to your directory with the latest version
31+
- rename the directory from 2.x.x to .bckup2.x.x (or simply delete it and download it later if wanted)
32+
- clone this repo
33+
`git clone https://github.com/sparkfun/Arduino_Apollo3.git`
34+
- checkout desired branch
35+
`cd Arduino_Apollo3`
36+
`git checkout release-candidate`
37+
- update all submodules
38+
`git submodule update --init --recursive`
39+
- rename directory from Arduino_Apollo3 to 2.x.x from above
40+
- restart Arduino and enjoy.
41+
42+
## Getting Started
43+
For in depth tutorials, checkout out the [Artemis page](https://www.sparkfun.com/artemis) for the latest. Tutorials that may be of interest include:
44+
- [Installing Board Definitions in the Arduino IDE](https://learn.sparkfun.com/tutorials/installing-board-definitions-in-the-arduino-ide)
45+
- [Artemis Development with the Arduino IDE](https://learn.sparkfun.com/tutorials/artemis-development-with-the-arduino-ide)
46+
47+
If you are comfortable with the arduino IDE and already have the boards installed, we recommend trying some examples from within the arduino IDE. Start with the "Built-in Examples" from arduino, but don't forget to checkout out some of the board specific examples that we have included with the package. These demonstrate how to use some of the libraries that make our Artemis board unique, and can take your next project to a new level!
3348

3449
## Development Status
3550

36-
* v2.0.0 based on an [mbed-os](https://github.com/ARMmbed/mbed-os) framework
51+
* v2.0.0 Based on an [mbed-os](https://github.com/ARMmbed/mbed-os) framework
52+
* v2.1.0 Contains latest fixes for the v2 core and feature that have been added since v2 release
53+
54+
For more information on how to contribute or how to navigate this repo, check out the [Contributing](./docs/CONTRIBUTING.md) page.
55+
56+
As mentioned MbedOS is the framework to our latest Arduino Core. To contribute to, or use these targets on, MbedOS check out the [main repo by ARM](https://github.com/ARMmbed/mbed-os). This library uses mbed libraries built from a fork of mbed that is maintained by us. The latest version of that repo can be found [here](https://github.com/sparkfun/mbed-os-ambiq-apollo3/tree/ambiq-apollo3-arduino).
3757

3858
**Main Arduino Features**
3959
* Serial: ✅
@@ -56,11 +76,11 @@ An mbed-os enabled Arduino core for Ambiq Apollo3 based boards
5676
* PDM Microphones / I2S: ✅
5777
* BLE: ✅
5878
* RTC: ✅
59-
* Watchdog Timer: 🤔
60-
* Multi-bit SPI: 🤔
79+
* Watchdog Timer:
80+
* Burst Mode: ✅
6181

6282
## More
63-
### [License](./docs/ISSUES.md)
83+
### [License](./docs/LICENSE.md)
6484
### [Contributing](./docs/CONTRIBUTING.md)
6585
### [Issue Template](./docs/ISSUES.md)
6686
### [Acknowledgements](./docs/ACKNOWLEDGEMENTS.md)

0 commit comments

Comments
 (0)