Difference between revisions of "LeapFrog Pollux Platform: Project"
(→Adding Wiki Pages)
|Line 64:||Line 64:|
Revision as of 07:03, 14 February 2013
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.
This is a list of wiki page To Do's. Things that need fixing, tutorials that need features, and or information that needs to be figured out.
- A guide to your first steps hacking the Didj updating, replace repeat info with links to tutorials.
- Need to figure out how to forward incoming requests, so that the devices are also accessible from outside the host PC. As of now the device can call out, but not much can call in.
- Didj_SD_MMC_Expansion Page says nothing about where/how to get the mmc drivers, I searched the didj, nothing returns for mmc.
- Compile and install mplayer for the explorer Something missing, uclibc issue perhaps? Won't compile.
- How To - Compile:
- Lightning Boot
- Emerald Boot
- NFS Rootfs booting
- Madplay won't play on LX missing /dev/dsp
Here is a place to list all the the goals or wants that we have for this project.
- Pollux Kernel in Mainline
- Generic Rootfs
- Custom or Modified
- Customizable Themes
- Custom or Modified
- GP2x / GP2X_Wiz
- 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
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.
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.
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
To Do - A place at the bottom of the page in bold heading, to list things that need to be added. These should probably be features, as a new page probably shouldn't be a work in progress or stub.
When talking about commands on the device itself use On <device> in italics two single quotes before and after, then the command with a #. To make code box, put a space as the first character of the line.
# find / | grep myfile
When talking about the host on host with a $.
$ mv myfile /my/directory/
Headings are generally == Heading == and ==== Sub Heading ==== then use steps (3 single quotes before and after) if you don't want it to show up the in the table of contents or to divide up smaller steps. Two lines 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.
Be sure to add Categories, check the source at the bottom of this page for a full list.