Check out the new MinnowBoard.org website for the most up-to-date information on the MinnowBoard Turbot and the MinnowBoard.org Community.

Showcase

From MinnowBoard Wiki
Jump to: navigation, search

Template for Showcase Project

Skill Level

The difficulty level of this project is:

EASY
Newcomers and those just getting started with MinnowBoard MAX.


STANDARD
Most MinnowBoard MAX projects will be in this category.


ADVANCED
Challenging projects for those looking to do more with their MinnowBoards.


DEVELOPERS
Supplemental information that may be of interest to certain kinds of developers.

Hardware Components Needed

Software Libraries / Dependencies

List the software libraries and dependencies (including versions!) needed to run this project. For example:

Process

When writing a tutorial that describes a sequential process, try to avoid using the "you" pronoun; instead, focus on the action verbs of the process:

 1.  Connect components
 2.  Download scripts, files 
 3.  Copy code to your system 
 4.  Make it your own
 5.  Test the experiment

Tips

Keep the tone as positive as possible; phrases like "remember to do this (smart thing)" are more friendly and less condescending than "don't do this (dumb thing)!"

An article with 4+ different level headings creates a Table of Contents (ToC) automatically. Try to document such that there is a navigable ToC.

Support

Users can find support related to the software, hardware, or whatever:


Formatting Help

Legend

Heading Largest

` == H2 Level == `

Heading Larger

` === H3 Level === `

Heading Base

` ==== Base Bold H4 Level ====`

Horizontal line


` ---- `

Bulleted List

Use bullets in outlining detailed topics underneath a `==== Base H4 ====` heading.

  • I. single asterisk is top-level bullet level (I, II, III, IV, V, VI ...)
    • A. two asterisks provide sub-level bullet A
    • B. ...
    • C. and so on.
      • 1. three asterisks provide sub-level detail about sub-bullet points
      • 2. ...
      • 3. and so on.
        • a. four asterisks begin outline at lower-case letter level
        • b. ...
        • c. and so on.

```

  • I. single asterisk is top-level bullet level (I, II, III, IV, V, VI ...)
    • A. two asterisks provide sub-level bullet A
    • B. ...
    • C. and so on.
      • 1. three asterisks provide sub-level detail about sub-bullet points
      • 2. ...
      • 3. and so on.
        • a. four asterisks begin outline at lower-case letter level
        • b. ...
        • c. and so on.

```

Documenting Code Blocks

Perhaps the most important task for an author of technical content is to ensure that code blocks render raw code. In general, MediaWiki provides a number of options for doing this. To drive consistency, we recommend choosing the formatting method based primarily on the number of lines of raw code you're documenting, preserving syntax of language. Use "nowiki" for documenting long blocks of code. Use 'preformatted' text for singular references to file and folder names within a given framework.

  # test a 'Hello, world' code block in C++ / Qt
	#include <QCoreApplication>
	#include <QDebug>
	 
	int main(int argc, char *argv[])
	{
	    QCoreApplication a(argc, argv);
	 
	    qDebug() << "Hello World!";
	 
	    return a.exec();
	}

  # test a 'Hello world' code block in Prolog
  main :- write('Hello, world!'), nl.

  # test a 'Hello, world' code block in Python 3
  print ("Hello, world") 

  # test a 'Hello, world' code block in Ruby
  puts "Hello, world"