[Nitro] I, Nitro
rob at robmela.com
Sat Nov 3 10:48:09 EDT 2007
We need to draw up a list of *what* formats we want to target.
A (START HERE) at the README RDoc level is a great idea. A README.intro
alongside the current README.og and README.raw.
What are the goals?
-- install Nitro
-- verify that it works
-- proove: useful common things are really simple in Nitro
If those are the goals, does this achieve them:
Intro I ( README.intro )
- single-file app ( with Controller and Dispatcher )
- starting and stopping
- canonical hello world app
. nitro --create
. a template
. a controller
. an element
Intro II ( Og ) ( README.intro2 )
- Library example ( Book and Author ), using admin part
( or something similarly simple but more exciting )
Intro III (? or maybe this belongs in a tutorial )
- Add a simple form to Intro II
At this point it's pushing the limits to becoming a tutorial...
Mark Van De Vyver wrote:
> On Nov 3, 2007 12:40 PM, * William <william.full.moon at gmail.com> wrote:
>> Hi gang
>> Personally speaking
>> i agree there must be a [START HERE] document like and induction set.
> agreed and at the risk of repeating myself ;) I think this
> 'introduction level information' is best done in the readme file,
> which can be duplicated elsewhere, but the readme version should be
> the reference point?
> More extensive introductory material/howto can be refereed to.
>> Secondly I prefer a cook book approach to the second level USER
>> BOTH these would be backed by solid PROGRAMMER level documentation.
> Agreed. In fact since I always have the pickaxe book and the Ruby
> cookbook on my desk I'd say that, for me, the best documentation
> (book) would be the Ruby cookbook with the pickaxe appendices.
> Is this a longer term target/structure worth setting and aiming for?
> It would kill the two birds with one document/book.
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 116 bytes
Desc: not available
Url : http://rubyforge.org/pipermail/nitro-general/attachments/20071103/04fcb98a/attachment.vcf
More information about the Nitro-general