Welcome to Macchina documentation.

Here is where you will find everything there is to know about the Macchina projects, including instructions for setting things up, diagrams, explanation of features, etc.

This is a evolving document that will continue to grow and improve as time goes on. In an effort to have the best documentation possible, we encourage you to give us feedback. If something looks unclear, is spelled wrong, missing, or whatever - please add a comment and we will do our best to address. Look for "Add new comment" at the bottom of a page. Thank you for your help!

PHILOSOPHY AND SHARING

We encourage feedback and any augmentations or improvements you might see fit to contribute back to the project. So if you want to fork it, make some changes, and submit a pull request ( https://help.github.com/articles/using-pull-requests ), we'll be glad to review the proposed changes and roll it back into the codebase if we think it will be helpful. And you're free to fork it into your own project, too, as long as you keep it open! We're using the LGPL license, so, while the library itself has to remain open, it doesn't force you to open-source your own code that might happen to use the library. We see this as a reasonable balance that allows a good amount of flexibility while still encouraging contribution back into the community.

Along with making projects very accessible and public, Github also makes sharing code snippets really easy, in the form of "Gists". A Gist is essentially a new Git repository, but trivial to create and share. So you could use it to start up a new project, or just show someone the order in which you like initializing all your I/O and data structures before reading the status from your battery charger. You can make new Gists here: https://gist.github.com/

If you want to embed Gists in your forum posts, there is a shorthand way to do that. All you have to do is type [gist:####] where #### is the numeric ID of the Gist you want to embed.

Let's try it here: