[CMake-Promote] Interesting blogs and random comments about CMake

Brad King brad.king at kitware.com
Fri Dec 16 16:28:34 EST 2005


Brandon J. Van Every wrote:
> Those of us on Windows don't automatically have man page readers set 
> up.
[snip]
> On Windows, it would be a good idea to provide "Start... Programs" menu 
> shortcuts to the documentation, as this is a standard way that Windows 
> users go about looking for such things.  Debatably, one could have a 
> "Documentation" button within CMakeSetup.  That's what the "Help" button 
> does in all other Windows apps, but CMakeSetup is using a simple dialog 
> box approach.  I think the message that "Help" currently displays is 
> helpful, so I'm not suggesting it be messed with.

The same code that generates the man page also generates a plain text 
file and an HTML file with the same documentation.  Linking to this from 
CMakeSetup or the Start Menu could be useful but may not be the best 
thing to do.

There are two kinds of documentation for CMake:

1.) Documentation for developers writing a CMake-ified project.

2.) Documentation for users building a CMake-ified project.

The automatically generated reference documentation is very helpful for 
#1 but has limited information for #2.

What we should probably add to the CMakeSetup GUI and ccmake dialog (and 
the WXWindows GUI) is a link to a document that shows an example session 
of using the dialog.  Then first-time users will be able to get started 
without searching for documentation.

-Brad


More information about the CMake-Promote mailing list