Difference between revisions of "LeapFrog Pollux Platform: Project"

From eLinux.org
Jump to: navigation, search
(Adding Wiki Pages)
Line 51: Line 51:
 
''' Tutorial Structure '''
 
''' Tutorial Structure '''
  
Summary - brief over view of the tutorial, what it is, what it does, how its done.
+
'' Summary '' - brief over view of the tutorial, what it is, what it does, how its done.
  
Needed Items - I usually do Software Needed, Hardware Needed, Programs Needed, basically a list of everything you will need to complete the tutorial, including links to those items when ever possible.
+
'' Prerequisites '' - Tutorials that need to be completed before starting the current one Optional
  
How To - The step by step process of the tutorial. Don't assume your audience knows what they are doing, yet don't get overly wordy about it. Make it to the point, informative, visually easy to work through, as in using headings, paragraphs, lists to organize the information, etc.
+
'' Software Needed '' - Source Code, data, configuration files, etc. Optional
 +
 
 +
'' Programs Needed '' - Any programs that should be installed on the host system. mtd-utils, 7z, hexeditor, etc Optional
 +
 
 +
'' Hardware Needed '' - Any hardware required. Cartridge, USB to Serial adapter, etc. Optional
 +
 
 +
'' Start Tutorial '' - First step of the actual tutorial, general name of the step, like Compiling or Installing.
 +
 
 +
'' Continue '' - as many as needed, nesting where possible with sub headings, so people can easily jump to a main step from the ToC
  
  
 
''' Tutorial Style '''
 
''' Tutorial Style '''
 +
When talking about commands on the device itself use On <device> in italics, then the command.
 +
 +
'' On Explorer ''
 +
find / | grep myfile
 +
 +
When talking about the host.
 +
 +
'' On Host ''
 +
mv myfile /my/directory/
 +
  
 
Headings are generally == Heading == and ==== Sub Heading ==== then use ''' bold ''' if you don't want it to show up the in the table of contents. Two spaces between sub sections also, as wiki wants a space between every line, this makes it easy to see the divisions. Its more important to be consistent to the page, than to the other pages, but it is nice, and makes it easier to follow information across all device pages. Also for other people editing the contents, it is a lot easier if its organized consistently.
 
Headings are generally == Heading == and ==== Sub Heading ==== then use ''' bold ''' if you don't want it to show up the in the table of contents. Two spaces between sub sections also, as wiki wants a space between every line, this makes it easy to see the divisions. Its more important to be consistent to the page, than to the other pages, but it is nice, and makes it easier to follow information across all device pages. Also for other people editing the contents, it is a lot easier if its organized consistently.

Revision as of 02:00, 8 July 2011

LeapFrog Pollux Platform Project Page

Here you will find information particular to the group of people involved in the project. Not how to do anything with the devices, just goals, desires, information pertaining to the group of people working on them.

Wish List

Here is a place to list all the the goals or wants that we have for this project.

  • Linux
    • Pollux Kernel in Mainline
    • Generic Rootfs
  • GUI
    • Custom or Modified
      • Customizable Themes
  • Homebrew Games
  • Overclock Processor


Adding Wiki Pages

We've tried to set up the wiki, so its useful, informative, and easy to use, as such, we've organized the data in a particular fashion, to hopefully facilitate those attributes. Some basic guidelines are

Namespace

  • Didj_<title>
  • Leapster_Explorer:_<title>
  • LeapPad_Explorer:_<title>
  • LeapFrog_Pollux_Platform:_<title>

If the tutorial you are writing applies specifically to one device, and is not possible to do, or done in a completely different way than any other device, then use the name specific to that device (Didj_ is not wrong, its a legacy issue). For example Leapster_Explorer:_USB_Host_Connection and link it from the device's main page. If it is possible to do what you are doing on all the devices, which there is a good chance you can, use LeapFrog_Pollux_Platform:_ for the prefix of the title. And link it from the LeapFrog Pollux Platform main page.


Tutorial Content

When ever possible check the main platform page, and the device pages for tutorials/how to's describing parts of your process. If you are building a kernel, link to the kernel configuration page, if you need console access, there is a tutorial for that already. Don't bother rewriting them. Explain any differences, such as options to select during kernel configuration, and link to that page.

This way if better ways are found, or especially if it includes hosted links, such as with the source code, if the files ever need to be hosted somewhere else, its only one page to change, and it won't break any other page links. Also new files can be added, making for easy updates.


Tutorial Structure

Summary - brief over view of the tutorial, what it is, what it does, how its done.

Prerequisites - Tutorials that need to be completed before starting the current one Optional

Software Needed - Source Code, data, configuration files, etc. Optional

Programs Needed - Any programs that should be installed on the host system. mtd-utils, 7z, hexeditor, etc Optional

Hardware Needed - Any hardware required. Cartridge, USB to Serial adapter, etc. Optional

Start Tutorial - First step of the actual tutorial, general name of the step, like Compiling or Installing.

Continue - as many as needed, nesting where possible with sub headings, so people can easily jump to a main step from the ToC


Tutorial Style When talking about commands on the device itself use On <device> in italics, then the command.

On Explorer

find / | grep myfile

When talking about the host.

On Host

mv myfile /my/directory/


Headings are generally == Heading == and ==== Sub Heading ==== then use bold if you don't want it to show up the in the table of contents. Two spaces between sub sections also, as wiki wants a space between every line, this makes it easy to see the divisions. Its more important to be consistent to the page, than to the other pages, but it is nice, and makes it easier to follow information across all device pages. Also for other people editing the contents, it is a lot easier if its organized consistently.

Spelling and Grammar, do your best to make it professional and easy to understand, I don't think there is a reason to get funny about it or anything else, just stick to the facts.