search

keyboardio / Kaleidoscope

Firmware for Keyboardio keyboards and other keyboards with AVR or ARM MCUs.
http://keyboard.io
GNU General Public License v3.0
756 stars 259 forks source link

Document how to write macros #630

Open algernon opened 5 years ago

algernon commented 5 years ago

Writing macros is another one of those things many of our users want to do, and where our existing documentation is more suited for the slightly more experienced reader. We'd like to have a step-by-step howto, which might not explain everything, but lets someone new to Arduino and programming in general, get started.

TG1999 commented 5 years ago

I want to work on this project with another project also How to install the third party plugins in Google Season of Docs. Any help to start will be great.

algernon commented 5 years ago

Hi @TG1999! Sorry for the incredibly late reply.

The best way to get started with bot this and #235, is to first set up a development environment (see the "Getting Started" block on our wiki), to make sure that any examples can be tested to at least compile. Next, is to look at some of the existing macros in our examples. These examples (the ones in the examples/ directory, that is) show some of the things one can do with macros. For a good step-by-step document, I think the best would be to come up with a few examples that show various aspects of macros. Some of them should be super simple, using the MACRODOWN helper (see the existing docs, linked to in the root issue), some should be more complicated like the AppSwitcher example.

As for installing third party plugins, I'll comment on #235.

TG1999 commented 5 years ago

Thanks @algernon fo the help.

TG1999 commented 5 years ago

Hi @algernon I have submitted my proposal with display name TG99.