README file could be a bit more modern and consistent

[Mike Taves]

The README file is starting to look a bit dated, since it doesn't include build instructions with CMake. It also has a mixture of tab indents, 2-space and 4-space indents.

I've gone through and quickly updated a few things:

• all two-space indents (because they are small)
• removed the "#" command prompt, since this is a comment to some shells, and I've added a few comments inline
• wrapped a few lines to a 80-character wide terminal

Please edit the attached patch as necessary.

[mloskot]

There are Wiki pages explaining build procedure

• BuildingOnUnixWithAutotools
• BuildingOnUnixWithCMake

Perhaps README could be just a copy of these pages. Or main README points to README.cmake, README.autotools, etc.

[Mike Taves]

Replying to mloskot:

There are Wiki pages explaining build procedure

Wikis are fine for the long detailed procedures, but the purpose of the README file is to quickly look up the procedure without needing to start up a web browser and navigate to the web page. A README file is the first place I look after uncompressing source code, since it tells me what to do next.

If anything, the README file could be shortened to remove Wiki-worthy content, but keep the basic build instructions.

[mloskot]

Good point. Agreed.

[strk]

Applied a slightly modified version (autotools also allows to build in separate tree). Committed as r2935.