Skip to content

Commit 28023b0

Browse files
committed
Fixup readme and issues template
1 parent e6e570b commit 28023b0

File tree

4 files changed

+18
-10
lines changed

4 files changed

+18
-10
lines changed

.github/ISSUE_TEMPLATE/compilation_bug_report.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ A clear and concise description of what the bug is.
1515
Issues without the full verbose output will be discarded as invalid.
1616

1717
**Mandatory: attach the sketch**
18+
or a Minimal reproducible example
1819
Issues without the sketch will be discarded as invalid.
1920

2021
**Additional context**

.github/ISSUE_TEMPLATE/miscellaneous_bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Miscellaneous bug report
3-
about: Sketch compile but doesn't upload, or similar issues
3+
about: Sketch compiles but doesn't upload, or similar issues
44
title: ''
55
labels: ''
66
assignees: ''

.github/ISSUE_TEMPLATE/runtime_bug_report.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Runtime bug report
3-
about: Sketch compile and uploads but doesn't run correctly (or doesn't run at all)
3+
about: Sketch compiles and uploads but doesn't run correctly (or doesn't run at all)
44
title: ''
55
labels: ''
66
assignees: ''
@@ -14,17 +14,19 @@ A clear and concise description of what the bug is.
1414
**Full verbose** compilation output, ideally with `arduino-cli` invocation or from IDE 2.3.3+
1515
Issues without the full verbose output will be discarded as invalid.
1616

17-
**Output of debug UART**
18-
Complete output of the console crash, starting from
17+
**Output of Serial Monitor**
18+
1. If you have an USB-to-Serial adapter, paste the complete output of the console crash, starting from
1919
```*** Booting Zephyr OS build v3.7...```
20-
Runtime issues without the **full UART output** will be discarded as invalid.
20+
2. If you don't, compile the sketch in `Debug` mode (see [Toubleshooting section](/troubleshooting)) and paste the output after invoking `sketch` command
21+
Runtime issues without the **full output** will be discarded as invalid.
2122

2223
**Output of readelf**
24+
You can find the loaction of the elf file by compiling in Verbose mode and looking near the end of the compilation output (after `Linking everything together..`)
2325
Paste (or attach) the output of `arm-none-eabi-readelf -a $your_sketch_elf_file`
2426

2527
**Optional: attach the elf file**
2628

27-
**Output: attach the sketch**
29+
**Optional: attach the sketch**
2830

2931
**Additional context**
3032
Add any other context about the problem here.

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,17 @@ export ZEPHYR_SDK_INSTALL_DIR=$folder_where_you_installed_the_sdk
4545
```
4646
The firmwares will be copied to [firmwares](/firmwares) folder.
4747

48-
If the board is fully supported by Zephyr, they can also be directly falshed with `west flash`
48+
If the board is fully supported by Zephyr, they can also be directly flashed with `west flash`
4949

5050
## Use the core in Arduino environment
5151

5252
After runnign the `bootstrap` script, you should be able to symlink the core to `$sketchbook/hardware/arduino-git/zephyr` and it will appear in the IDE/CLI. Boards FQBN will then become `arduino-git:zephyr:name_from_boards_txt`
5353

54-
## Toubleshooting
54+
## Troubleshooting
5555

5656
**Q: My Sketch doesn't start (Serial doen't appear)**
5757

58-
**A:** Connect a USB-to-UART adapter to the default UART (eg. TX0/RX0 on Giga, TX,RX on Nano) and read the error message
58+
**A:** Connect a USB-to-UART adapter to the default UART (eg. TX0/RX0 on Giga, TX,RX on Nano) and read the error message (with the sketch compiled in `Default` mode). If you don't own a USB-to-UART adapter, compile the sketch in `Debug` mode; this will force the shell to wait until you open the Serial Monitor. Then, run `sketch` command and *probably* you'll be able to read the error (if generated by `llext`). For OS crashes, the USB-to-UART adapter is the only way to collect the crash.
5959

6060
**Q: I did it and I get a `<err> llext: Undefined symbol with no entry in symbol table ...`**
6161

@@ -65,7 +65,7 @@ After runnign the `bootstrap` script, you should be able to symlink the core to
6565

6666
**A:** Open the `.conf` file for your board, add the required `CONFIG_`, recompile/upload the loader.
6767

68-
**Q: I get an OS crash**
68+
**Q: I get an OS crash, like `<err> os: ***** USAGE FAULT *****`**
6969

7070
**A:** This is usally do to some buffer overflow/coding error in the user's own code. However, since the project is still in Beta, a [good bug report](#bug-reporting) could help identifying an issue in our code.
7171

@@ -77,6 +77,10 @@ After runnign the `bootstrap` script, you should be able to symlink the core to
7777

7878
To report a bug, open the [issues](/issues) and follow the instructions. Any issue opened without the needed information will be discarded.
7979

80+
## ArduinoBLE
81+
82+
BLE stack is enabled for Nano 33 BLE; please use [this branch](https://github.com/facchinm/ArduinoBLE/tree/zephyr_hci) to test it.
83+
8084
## TODO
8185

8286
- [ ] Unify overlay in [loader](/loader/boards) with the one provided in [variant](/variant) for interoperability with GSoC project
@@ -88,6 +92,7 @@ To report a bug, open the [issues](/issues) and follow the instructions. Any iss
8892
- [ ] Replace [llext_exports.c](/loader/llext_exports.c) with proper symbols generation (via inclues)
8993
- [ ] Provide better usability for `Debug` builds (eg. shell over USB)
9094
- [ ] Fix corner cases with `std::` includes (like `<iterator>`)
95+
- [ ] Get rid of all warnings
9196

9297
## ADVANCED: Add a new target board
9398

0 commit comments

Comments
 (0)