[sldev] Making the build instructions better

Alissa Sabre alissa_sabre at yahoo.co.jp
Thu Jan 1 06:08:46 PST 2009


> I've updated the build instructions on Linux:

> Here's the umbrella page for all platforms

> Currently, the page is split up into platform specific prep pages, and
> then a general "CMake" page after that.  Michelle2's page is
> consolidated into one big page.  Which is the better approach?

I believe it's best to create per-platform pages that contain all
information appropriate for the platform.  Also, each
platform-specific page should show very detailed step by step
instruction of the basic build option.  All platform-specific pages
are organized in a same format, and information common to all
platforms should be in all platform pages in exactly same words.

The intention is to give first-time builders a straightforward
instruction that works, without going many pages back and forth.  I
also assume that most of the builders start working on one platform.
And *if* he/she is successfull on his/her first platform, he/she *may*
start building on his/her second platform.  The similarity of the
platform pages helps understanding which parts are same and which
parts are not.

In a past, I was updating the build instruction pages based on the
above consideration, by small and small, but it was unsuccessful.  I
at last understood that most of the wiki updators work only on one
platform, and he/she just updates his/her platform page without being
bothered by pages for other platforms...  *sigh*

    Alissa Sabre
--------------------------------------
Power up the Internet with Yahoo! Toolbar.
http://pr.mail.yahoo.co.jp/toolbar/


More information about the SLDev mailing list