Front Page


The first paragraph or two should always have some text explaining what this page is about. Think of it as an extended abstract that summarizes what is here, its purpose, who it is for, its state of development, and anything else that will help a person quickly decide if this is something they want.

Important: (or notes, or whatever label you want) are things you want to emphasize, such as "This code is no longer supported. Use it at your own risk."

Contents



Download and Installation

This section contains zip files, PDFs, links etc. to the software and / or any other essential material required to actually do the work.

  • My Toolkit (zip file). Download / unzip the My Toolkit library (which includes documentatio)n into a folder with a descriptive name (e.g., MyToolkit).

To install:

  • Step by step instructions on how to install it. This could be a separate page if its long and/or has lots of visuals.

Recipes and How-To's

  • Basic Uses. A list of short, usually descriptive examples of how to do something. These are usually not tutorials including code, but may include e.g., coding practices, approaches, etc.
  • [MyToolkitRecipe2|AdvancedUses]]. Some more things on how to do something.

Tutorials and Examples

This section continues (usually simple) examples of how to use your code and / or system. Start with the most basic (as it serves as a tutorial) so that the progression through the example also reflect a learning progression.

Tutorials

  • Tutorial1. Learn how to blah. This is actually all detailed out on its own page
  • Tutorial1. Learn how to do more blah.

Presentations

Examples

  • Example 1. Even more blah, but in this case its just an example of some source code that the person can go through.

Links

The links section contains pointers to thing that are not part of the cookbook, or to things that you just want to make easier to get. Documentation/Code

Papers / Videos

  • Links to Papers and videos, if any, generated from this project

Updated September 26, 2012