From 174885dbed236693cab61fbb7641a98ff29aa1df Mon Sep 17 00:00:00 2001 From: Nick Winans Date: Sun, 25 Sep 2022 23:39:14 -0500 Subject: [PATCH] Add basic readme's --- app/boards/shields/nice_view/README.md | 5 +++++ app/boards/shields/nice_view_adapter/README.md | 11 +++++++++++ 2 files changed, 16 insertions(+) create mode 100644 app/boards/shields/nice_view/README.md create mode 100644 app/boards/shields/nice_view_adapter/README.md diff --git a/app/boards/shields/nice_view/README.md b/app/boards/shields/nice_view/README.md new file mode 100644 index 00000000..0b4ac21f --- /dev/null +++ b/app/boards/shields/nice_view/README.md @@ -0,0 +1,5 @@ +# nice!view + +The nice!view is a low power, high refresh rate display meant to replace I2C OLEDs traditionally used. + +This shield requires that an `&nice_view_spi` labelled SPI bus is provided with *at least* MOSI, SCK, and CS pins defined. diff --git a/app/boards/shields/nice_view_adapter/README.md b/app/boards/shields/nice_view_adapter/README.md new file mode 100644 index 00000000..e97aee4f --- /dev/null +++ b/app/boards/shields/nice_view_adapter/README.md @@ -0,0 +1,11 @@ +# nice!view Adapter + +This shield is used as an adapter between the nice!view and existing shields/boards that expose an I2C OLED header. + +To use this shield, you should add this shield to your list of shields *before* `nice_view`. + +The nice!view will use the SDA/SCL pins of the OLED, and then the adapter expects a final pin to be "bodged" from your microcontroller to the nice!view CS pin. + +``` +west build -b nice_nano_v2 -- -DSHIELD="lily58_left nice_view_adapter nice_view" +```