GCI Documentation Tasks

GCI_Doc_tasks-2011.txt

1. Update READMEs throughout the Parrot repo:

./ext/nqp-rx/README
./ext/winxed/README
./runtime/parrot/library/PCT/README
./runtime/parrot/include/README
./runtime/parrot/dynext/README
./examples/sdl/minesweeper/README
./examples/sdl/tetris/README
./examples/languages/abc/README
./examples/languages/squaak/README
./examples/tge/README
./examples/pir/befunge/README
./examples/README
./examples/shootout/README
./examples/mops/README
./compilers/tge/README
./src/dynoplibs/README
./tools/build/README
./tools/release/README
./docs/book/draft/README
./docs/imcc/README
./t/native_pbc/testdata/README
./t/archive/README
./t/manifest/README
./t/perl/README
./t/run/README
./t/src/README
./t/tools/pmc2cutils/README
./t/tools/install/testlib/README
./ports/ubuntu/README
./ports/cygwin/README

Note: Several of the above READMEs are rather small, containing only a paragraph or two.  Otherwise, they should take about one day to complete.

2. Write *.pod files for all of the installable binaries in the Parrot repo (which we then can run through pod2man to create manpages):

ops2c
parrotbug
parrot_debugger
parrot_config
parrot_nci_thunk_gen
parrot-nqp
parrot-prove
pbc_disassemble
pbc_dump
pbc_merge
pbc_to_exe
winxed
plumage

NOTE: I am unsure, but, I think, each should take only one day.

3. Write duplicate, accompanying articles to (a) Programming Parrot -- Using objects and (b) Programming Parrot -- PMCs, using the winxed programming language rather than PIR.

NOTE: These may prove challenging, taking four or five days for each one.