alvinlollo/Studuino
1
0
Fork 0
Code Issues 2 Actions Projects 1 Releases Activity

Add Studuino boilerplate, autocomplete snippets, and AGENTS.md instructions

Browse Source
This commit is contained in:
alvinlollo
2026-10-09 12:59:00 +11:00
parent 75d2099655
commit ed32bcedd2
3 changed files with 92 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+18
View File
@@ -0,0 +1,18 @@
# Studuino Development Instructions
## Environment Setup
- Run `./setup.sh --with-editor` to install `arduino-cli` and `clangd`.
- **Mandatory Configuration**: Create `.arduino_config.lua` in the root with `board` and `port` settings for `Arduino-Nvim` to function.
## Development Workflow
- **Boilerplate**: Use the `studuino_boilerplate` snippet to insert required headers and the `Studuino board` instance.
- **Snippets**: Project-specific snippets are located in `.vscode/studuino.code-snippets`.
- **Build & Upload**: Use the following Neovim leader keybindings:
- `<Leader>mc`: Compile (`:InoCheck`)
- `<Leader>mu`: Upload (`:InoUpload`)
- `<Leader>mm`: Serial Monitor (`:InoMonitor`)
## Repo Structure
- **Libraries**: Custom or adapted libraries are under `/libraries/`. Key libraries used in Studuino projects include:
- `ColorSensor`, `MPU6050`, `BusIOForStuduino`, `Clock`, `Servo`, `Adafruit_CircuitPlayground`, and `IRremoteForStuduino`.
- When adding new functionality, ensure the corresponding header files are included in your sketches as shown in the boilerplate.