diff options
author | Nick Brassel <nick@tzarc.org> | 2021-10-07 10:57:48 +1100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-10-07 10:57:48 +1100 |
commit | b2a186cf92d91bbb7f98fff68c4edf571909bf89 (patch) | |
tree | c58eca68f1ca0797b8080c32be3d14b10abd286a /quantum/visualizer/readme.md | |
parent | bc1f5ef38172bc77a802fb779e5da60f800c231b (diff) |
Purge uGFX. (#14720)
* Purge uGFX.
* Remove remnants of visualizer.
* Remove remnants of uGFX.
Diffstat (limited to 'quantum/visualizer/readme.md')
-rw-r--r-- | quantum/visualizer/readme.md | 18 |
1 files changed, 0 insertions, 18 deletions
diff --git a/quantum/visualizer/readme.md b/quantum/visualizer/readme.md deleted file mode 100644 index 298efb742f..0000000000 --- a/quantum/visualizer/readme.md +++ /dev/null @@ -1,18 +0,0 @@ -# A visualization library for the TMK keyboard firmware - -This library is designed to work together with the [TMK keyboard firmware](https://github.com/tmk/tmk_keyboard). Currently it only works for [Chibios](http://www.chibios.org/) - flavors, but it would be possible to add support for other configurations as well. The LCD display functionality is provided by the [uGFX library](https://ugfx.io/). - -## To use this library as a user -You can and should modify the visualizer\_user.c file. Check the comments in the file for more information. - -## To add this library to custom keyboard projects - -1. Add tmk_visualizer as a submodule to your project -1. Set VISUALIZER_DIR in the main keyboard project makefile to point to the submodule -1. Define LCD\_ENABLE and/or LCD\_BACKLIGHT\_ENABLE, to enable support -1. Include the visualizer.mk make file -1. Copy the files in the example\_integration folder to your keyboard project -1. All other files than the callback.c file are included automatically, so you will need to add callback.c to your makefile manually. If you already have a similar file in your project, you can just copy the functions instead of the whole file. -1. Edit the files to match your hardware. You might might want to read the Chibios and UGfx documentation, for more information. -1. If you enable LCD support you might also have to write a custom uGFX display driver, check the uGFX documentation for that. You probably also want to enable SPI support in your Chibios configuration. |