[waffle] [PATCH 03/18] README_WIN: add some notes about configuring and building WGL

[Chad Versace]

On 07/23/2014 08:40 AM, Emil Velikov wrote:
> On 23/07/14 16:13, Jose Fonseca wrote:
>> On 23/07/14 04:31, Emil Velikov wrote:
>>> TODO:
>>>   - Fill in the missing sections.
>>>   - Move to a better place.
>>>   - Double-check for typos and thinkos.
>>>
>>> Signed-off-by: Emil Velikov <emil.l.velikov at gmail.com>
>>> ---
>>>   README_WIN.txt | 157
>>> +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>>>   1 file changed, 157 insertions(+)
>>>   create mode 100644 README_WIN.txt

>> Isn't this duplicate info?
>>
>> Instead of breaking things into "build" "install" and "package", I'd first
>> break things into platform, and then, internally split into build install
>> package.  Otherwise people need to jump back forth alot unnecessarily. Plus
>> there's a lof of duplication.
>>
> Indeed it does. This is a mere copy-paste from the current README. Will need
> to see with Chad what his plans are on the topic, as waffle currently forwards
> people to ./doc/building.txt which seems to be missing on my tree.

Thanks for pointing out the out-of-date instructions in the README. I just pushed
updated build instructions [1] to branches 'master' and 'next'.

I agree with Jose here. The build instructions would be easier to follow if they
were first split by platform, then split into configure/build/install. Also, let's
put this info into the main README where the build instructions currently live for
Linux and Mac. There's no need to ostracize the Windows instructions in a separate file
like it's a second-class citizen. Being in the same file will also allow you to reference
other sections of the file instead of copying them.

As a side node, if you do need to add additional README files in the future, please name
them "README.lowercase_topic.txt" or "README.camelCaseTopic.txt". For example, this file would have been
"README.windows.txt".

[1] https://github.com/waffle-gl/waffle/commit/1ed60d0639ee3d33b9c1b542b021cfaf67d24125