Documentation and grunt tasks
Simser, Bil
I’m kind of a fuddy duddy when it comes to documentation as I find OSS projects just get the stuff out there but forgot or don’t have time to make documentation or help very useful. While we all don’t RTFM I want to make sure we have a good level of help with nu (and willing to just do it if need be, but hoping people with chip in with patches). I know, it’s grunt work but in the end I think it makes for a polished product and helps adoption grow.
It’s great we have the start of some new help. Let’s keep it going.
For example here’s the output when I type “nu”
C:\Users\bsimser>nu
Nubular, version 0.2.0
["Usage: nu install PACKAGE [options]", "\nConfig: nu config NAME VALUE", "\nRep
ort: nu report"]
-v, --version VERSION Specify version of package to install
-r, --report Report on the packages currently installed
in the lib folder
-V, --verbose
-q, --quiet
-h, --help Display this screen
And here’s the output when I type “gem”
C:\Users\bsimser>gem
RubyGems is a sophisticated package manager for Ruby. This is a
basic help message containing pointers to more information.
Usage:
gem -h/--help
gem -v/--version
gem command [arguments...] [options...]
Examples:
gem install rake
gem list --local
gem build package.gemspec
gem help install
Further help:
gem help commands list all 'gem' commands
gem help examples show some examples of usage
gem help platforms show information about platforms
gem help <COMMAND> show help on COMMAND
(e.g. 'gem help install')
gem server present a web page at
with info about installed gems
Further information:
Like I said, its minor stuff and of course working software over documentation is my goal but let’s just try to be clean as we go and keep our windows in good repair.
Brendan Erwin
[06:15:20] Miracle-Max: $ nu
Nubular, version 0.1.21
Nu will automatically download and install specified library packages into your lib folder, along with all their dependencies.
Usage:
nu -h/--help
nu --version
nu COMMAND [arguments...] [options...]
Examples:
nu install fluentnhibernate
nu install nunit --version 2.5.7.10213.20100801
nu config lib.location ./lib
nu report
nu install fluentnhibernate --report
Options and Switches:
-v, --version VERSION Specify version of package to install
-r, --report Report on the packages currently installed in the lib folder. When called as a switch it will run the report AFTER executing the requested command.
-V, --verbose
-q, --quiet
-h, --help Display this screen
Further Information:
http://nu.wikispot.org
http://groups.google.com/group/nu-net
[06:17:07] Miracle-Max: $
It is available in: http://github.com/brendanjerwin/nu/tree/fancy_help
The `nu help COMMAND` and `nu COMMAND --help/-h` functionality is not yet available, but I plan on adding it in too.
Brendan Erwin
This should be just what you need:
http://brendanjerwin.com/development/dotnet/nuproj/2010/09/19/wiki-managed-help-command.html
You can edit the docs here:
http://github.com/nu/nu/wiki/_pages
The command documentation needs some loving at the moment... http://github.com/nu/nu/wiki/help-commands
Maybe there is some content that can be collected from other places and put here? Is there any useful user guidance buried in this mailing list or in the other wiki?
On Aug 30, 2010, at 2:06 PM, Simser, Bil wrote: