Seems I've hit some sensitivity here. If so, I'm sorry.
I was just looking for some help in response to a helpful email from
Stefan who has also responded helpfully to mine of Tue, Dec 11, 2007
at 08:22:59AM +1100.
To me, the README and INSTALL files in the LyX root directories are
excellent examples of what I call "proper README files"
A README file usually tells about the package, what its for, what it
does etc..
An INSTALL file usually gives straight-forward instructions, for a
user (not just a developer) on how to build and install the package.
My ideas are based on the README and INSTALL files contained in
hundreds of packages that I have built and installed over the years.
The lyx1.5svn/development/cmake/Install.cmake file looks to me like
some sort of a make file.
The extensive comments later on in the file are probably very
informative (and valuable) to experienced cmake users. However to a
beginning simpleton like me they provide no help at all.
The following INSTALL instructions provided by Stefan are what a
novice like me needs:
"In fact you only create the project with the provided commands:
* create a build directory, e.g. .../trunk/../build
* call in the build directory 'cmake .../trunk/development/cmake -G
Xcode'
* open .../trunk/../build/lyx-qt4.xcodeproj
Then just open the project from Xcode and start compiling. All that
works fine with the opensource Qt version _in binary form_. No need to
compile Qt yourself."
Hope this helps
Roger
On 11/12/2007, at 8:54 AM, Andre Poenitz wrote:
On Tue, Dec 11, 2007 at 08:22:59AM +1100, Roger Mc Murtrie wrote:
Correction to previous post.
install.cmake doesn't look like a README.
[Well, your email doesn't look like a reply to an email either,
yet I suppose most people somehow manage to cope with it. *sigh*]
I got the impression that it was off an internet search.
It's indeed the only hit you get from Google when searching for
"though LyX usually uses". That's probably where the author(s) got
the original contents from...
There doesn't seem to be a README.cmake file in LyX 1.5 or 1.6
versions.
H'm, looks like it was renamed because it really isn't a README
file or an
INSTALL instructions file either for that matter.
A proper README.cmake file would be nice.
I would be grateful if you could enlighten me as to what constitutes
a "proper README.cmake file". One of the Google hits points to
e.g. https://trac.declarativity.net/changeset/1?format=diff&new=1
which does not look too different in structure and contents
to the file present in the LyX sources. So what exactly
wrong with README.cmake and how should it be corrected?
My point was that neither the LyX 1.5svn root or developement/cmake
directory contains a file entitled README.cmake. Not a complaint,
just an observation based on a suggestion that I look for one there.
www.cmake.org has a documentation page.
Indeed.
I fail to see a connection, though.
The connection is that I needed simple instructions on how to use cmake.
Thanks Stefan for providing the simple instructions to get me on my
way with cmake.
Hopefully that will provide any needed instructions.
To create a "proper README.cmake file"? Where?
In development/cmake I suppose.
Andre'
