GUIDE.md

User Guide

Configuration file specification

Valid configuration file names: LabAvrProject, avr-project, bavar, bavar-project.

(name <name>)
(target <mcu> <hz/n-mhz>?)
;; (target attiny13) | (target ... 1_000_000) | (target ... 1mhz)

(lang <standard>)
(strict <bool>) ; true by default

(build.debug <opts>) ; for debug
(build <opts>) ; for release
;; <opts>:
;;  O<n>          - optimization level
;;  lto           - enable lto (off for debug and on for release)
;;  (lto <bool>)
;;  no_std        - disable libc and set '_start' as entrypoint
;; intel_hex      - enable Intel HEX generation from ELF firmware
;; intermixed     - enable dissembled mix generation
;; <flag>          - custom user arguments starts with '-'


(program.id <programmer-id>) ; usbasp by default
(program.port <path>)

(envs <key-value ...>) ; set defines
;; (envs (MAGIC_NUMBER 123) (SD x))

(depends <libraries>) ; import libraries for project
;; (libraries
;;   ./local/dir                    ; import local project
;;   https://github.com/user/repo)  ; auto-download from Internet
;;   http://192.168.0.0/private-repo.git

(resources <paths>) ; bundle resource files

(dev <opts>)
;; clangd or compile_flags.txt  - generate config for clangd
;; c_cpp_properties - generate config for vscode c/c++ extension

Project Layout

• _build - artifact's directory
• src/ - source files

Resources

As is

Converts the file to a set of bytes as is.

In configuration file.

(resources image.bin)

In code, you can reference the resource content using the IMAGE_BIN variable.

IMAGE_BIN; // const unsigned char [] PROGMEM

Horizontal 1bit

A file for conversion to a horizontal 1bit image (for monochrome OLED as an example) should end with .1bit.bmp.

(resources image.1bit.bmp)

Depends

Allowable dependency values:

• Local paths (to be found from the root project directory)
• https://github.com/* (convert to https://github.com/*.git)
• http*.git

Remote dependencies are cloned into the _build directory. To update them, you need to clear the cache (remove the build directory).