Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to write macros #630

Open
algernon opened this issue Apr 23, 2019 · 3 comments

Comments

Projects
None yet
2 participants
@algernon
Copy link
Member

commented Apr 23, 2019

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

This comment has been minimized.

Copy link

commented May 9, 2019

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

This comment has been minimized.

Copy link
Member Author

commented May 28, 2019

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

This comment has been minimized.

Copy link

commented Jun 3, 2019

Thanks @algernon fo the help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.