Skip to content

Commit 9b23b4e

Browse files
authored
Added better code blocks
1 parent fb6c7bc commit 9b23b4e

File tree

1 file changed

+88
-10
lines changed

1 file changed

+88
-10
lines changed

README.md

Lines changed: 88 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -166,17 +166,95 @@ deploy:
166166
1. Install arduino-cli from here: https://arduino.github.io/arduino-cli/installation/
167167
2. Download ci-arduino
168168
* `git clone https://github.com/adafruit/ci-arduino`
169-
3. Put these lines in `.bashrc` or `.bash_profile` if you're on OSX. Make sure to fill in the path to where you installed ci-arduino and replacing USER with your username.
170-
* `alias test-platforms='python3 ~/path/to/ci-arduino/build_platform.py'`
171-
* `export HOME=/home/USER/`
169+
3. Put these lines at the end of your `.bashrc` or `.bash_profile` if you're on OSX. Make sure to fill in the path to where you installed ci-arduino and replacing USER with your username.
170+
```bash
171+
alias test-platforms='python3 ~/path/to/ci-arduino/build_platform.py'
172+
export HOME=/home/USER/
173+
```
172174
4. Run this at the top level of the library you want to test
173-
* `export GITHUB_WORKSPACE=$(pwd)`
175+
```bash
176+
adafruit@adafruit:~/Adafruit_BMP183_Library$ export GITHUB_WORKSPACE=$(pwd)
177+
```
174178
5. Remove everything in test library, and re-create it
175-
* `rm -rf ~/Arduino/libraries/Adafruit_Test_Library/; mkdir ~/Arduino/libraries/Adafruit_Test_Library`
179+
```bash
180+
adafruit@adafruit:~/Adafruit_BMP183_Library$ rm -rf ~/Arduino/libraries/Adafruit_Test_Library/; mkdir ~/Arduino/libraries/Adafruit_Test_Library
181+
```
176182
6. Still in the top-level directory of the library you'll be testing, copy the current library to Adafruit_Test_Library
177-
* `cp -r * ~/Arduino/libraries/Adafruit_Test_Library`
183+
```bash
184+
adafruit@adafruit:~/Adafruit_BMP183_Library$ vi .github/workflows/githubci.yml
185+
```
178186
7. Find out what boards to test. Open .github/workflows/githubci.yml and find the line that runs build_platforms.py.
179-
8. Run test-platforms. This will take a while, and tests for some boards run orders of magnitude slower than tests for other boards.
180-
* `test-platforms main_platforms`
181-
* OR, if githubci.yml specified other boards, let's say the metro m0 and pyportal:
182-
* `test-platforms metro_m0 pyportal`
187+
```bash
188+
vi .github/workflows/githubci.yml
189+
```
190+
These are the lines you're looking for
191+
```bash
192+
- name: test platforms
193+
run: python3 ci/build_platform.py main_platforms
194+
```
195+
8. Run test-platforms. This may take a while, and tests for some boards sometimes run orders of magnitude slower than tests for other boards.
196+
```bash
197+
test-platforms main_platforms
198+
```
199+
OR, if githubci.yml specified other boards, let's say the metro m0 and pyportal, you'd run this:
200+
```bash
201+
test-platforms metro_m0 pyportal
202+
```
203+
204+
Here's what that returns
205+
```bash
206+
adafruit@adafruit:~/Adafruit_BMP183_Library$ test-platforms main_platforms
207+
build dir: /home/dherrada/Adafruit_BMP183_Library
208+
209+
########################################
210+
INSTALLING ARDUINO BOARDS
211+
########################################
212+
arduino-cli core update-index --additional-urls https://adafruit.github.io/arduino-board-index/package_adafruit_index.json,http://arduino.esp8266.com/stable/package_esp8266com_index.json,https://dl.espressif.com/dl/package_esp32_index.json,https://sandeepmistry.github.io/arduino-nRF5/package_nRF5_boards_index.json > /dev/null
213+
214+
Installing Adafruit Unified Sensor
215+
arduino-cli lib install "Adafruit Unified Sensor" > /dev/null
216+
arduino-cli lib uninstall "Adafruit BMP183 Library"
217+
Library Adafruit BMP183 Library is not installed
218+
Libraries installed: ['/home/adafruit/Arduino/libraries/Adafruit_VL53L0X', '/home/adafruit/Arduino/libraries/RTClib', '/home/adafruit/Arduino/libraries/Adafruit-RGB-LCD-Shield-Library', '/home/adafruit/Arduino/libraries/readme.txt', '/home/adafruit/Arduino/libraries/Adafruit_Test_Library', '/home/adafruit/Arduino/libraries/Adafruit_Unified_Sensor']
219+
elif isinstance(platform, collections.Iterable):
220+
################################################################################
221+
SWITCHING TO arduino:avr:uno
222+
Installing arduino:avr ✓
223+
################################################################################
224+
BMP183test.ino ✓
225+
################################################################################
226+
SWITCHING TO arduino:avr:leonardo
227+
Installing arduino:avr ✓
228+
################################################################################
229+
BMP183test.ino ✓
230+
################################################################################
231+
SWITCHING TO arduino:avr:mega:cpu=atmega2560
232+
Installing arduino:avr ✓
233+
################################################################################
234+
BMP183test.ino ✓
235+
################################################################################
236+
SWITCHING TO arduino:samd:arduino_zero_native
237+
Installing arduino:samd ✓
238+
################################################################################
239+
BMP183test.ino ✓
240+
################################################################################
241+
SWITCHING TO esp8266:esp8266:huzzah:eesz=4M3M,xtal=80
242+
Installing esp8266:esp8266 ✓
243+
################################################################################
244+
BMP183test.ino ✓
245+
################################################################################
246+
SWITCHING TO esp32:esp32:featheresp32:FlashFreq=80
247+
Installing esp32:esp32 ✓
248+
################################################################################
249+
BMP183test.ino ✓
250+
################################################################################
251+
SWITCHING TO adafruit:samd:adafruit_metro_m4:speed=120
252+
Installing adafruit:samd ✓
253+
################################################################################
254+
BMP183test.ino ✓
255+
################################################################################
256+
SWITCHING TO adafruit:nrf52:feather52840:softdevice=s140v6,debug=l0
257+
Installing adafruit:nrf52 ✓
258+
################################################################################
259+
BMP183test.ino ✓
260+
```

0 commit comments

Comments
 (0)