describe sugar

We will create documentation and specifications from the Sugar activities to use as a guide to porting them.

Our Sugar desktop projects to explore and describe are:

• Fractionauts
• FractionBounce
• Lemonade-Stand
• math-hurdler
• AngleGators

We'll begin Wednesday, April 15, to work on their descriptions.

The first priority is to convey quickly the essence, the basics. I'd like to see something substantial on this no later than Monday, April 20. At this level, someone should be able to look at any re-implementation following this description and see that it was inspired by the original, even if it does not follow the original in exact detail. This will describe the overall theme of the game and its basic operation. Screenshots or short video snippets of game action might be very useful here but are not required.

The next priority is to give detail about the design. Here, more specific details of appearance matter. These might include character graphics or game piece appearance, size, and movement; text display contents, locations, and appearance; color palettes, descriptions of animations, and more. Locations relative to the project root of any media assets should come in at this stage to allow re-implementors to re-use this components easily.

The final priority is implementation specifics at a detailed level. Describe key features of how the code works, prioritizing anything specific about this game in particular. Commonly-used techniques may be mentioned along the way. Try to explain with pseudo-code and without copying and pasting large chunks of project code. You can make reference to line numbers or ranges of line numbers in the code. If there is a short snippet of just a few lines or less that are particularly succinct, you can include that along with your own verbal description.

We will open an issue for each project, titled "describe Sugar activity Project-Name" and including in the body of the first comment a URL to this describe-sugar.md wiki page.

Your report will go in Markdown files of the form:

describe_sugar_Project-Name.md

Probably most useful to put these files in sugarizer-lite/hfoss-2195 but draft content can be included in the issues or the wiki.