Skip to content

Instantly share code, notes, and snippets.

@13protons
Last active August 29, 2015 14:07
Show Gist options
  • Save 13protons/92386e8b46101609e17d to your computer and use it in GitHub Desktop.
Save 13protons/92386e8b46101609e17d to your computer and use it in GitHub Desktop.
Zetta Recipe Boilerplate
layout title author difficulty duration description repo
recipe
your title
your name
beginner
hobbyist
moderate
experienced
pro
1-3 hours
Large intro text goes here
link to source code needed for this recipe...git repo pages are great

This recipe will guide you through building something. Write a paragraph (or 2 at most) to introduce your recipe here.

Does this recipe deal with hardware, or software, or both? What level of commitment are we talking about here?

clockwise{:.icon} Estimated time to complete is [your estimated completion time].

Materials

These are the materials we use in this tutorial. You can order the complete kit from sparkfun:

cart{:.icon} Order the Complete Kit

You can also substitute your own parts if you're feeling adventurous.

Here's the parts list:

<script src="https://www.sparkfun.com/wish_lists/95647.js"></script>

To embed a parts list like the one avoce, create a wishlist on sparkfun.com. While viewing your wishlist, click on "+ Share this wish list" near the top of the page to get the <scipt> embed code. Drop that code in like the parts list above.

Setup

Get started on [Hardware]

This is a great place to point people to guides about getting setup on arduino, beaglebone, etc. No need to talk about setting up FTDI drivers or anything on that level in your recipe.

Download the starter code

Is this recipe based on a git repo? If so, this is a great place for it.

Recipe Steps

  1. Link to first h1 What kind of info is in the first section?
  2. Link to second h1 Make sure you inventory all your steps in this section for easy nav. {:.steps}

#1. Step 1

Intro paragraph

##Hardware

Hardware setup. Make sure to include photos and/or fritzing diagrams here.

Code

Add code and instructions for writing it in this section

TIP Don't forget to use tips!

What is this code doing?

Explanations are awesome!

##What just happened?!

Wrap up your section here. Remember what Aristotle said:

  1. Tell them what you're about to tell them.
  2. Tell them.
  3. Tell them what you just told them.

#2. Step 2

Copy sections from step 1

#Next Steps

  1. Leave your readers with follow up steps
  2. Maybe it's to tweet about their project
  3. Maybe it's a way of extending this work or linking to a more advanced recipe

#Getting Help

Make sure readers can get in touch with you if they need to.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment