Review: [PATCH] Add documentation for README_mac.txt

[Devin Weaver]

Bram asked me to post this here for code review. Anyone ok taking a
gander at this? I'll collect and address comments before telling Bram it
is ok to merge this on vim-dev. Thanks.

This is long over due. I realize that the Mac versions of things have
moved to MacVim and most people install via Homebrew without giving
second thought to the actual Vim source. However, I tend to jump to
README_mac.txt when I clone the Vim source. Every time I do a small
little kitten in Suburbia Ville cries uncontrollably. I can't be the
only one who pines for some Mac love in the main Vim source.

Well here is a first draft of such documentation. Along with homage to
the great options like MacVim and Homebrew. And some (inadequate) advise
on how to go about things on their own.

Hope this helps round out a very tiny yet neglected part.
---
README_mac.txt | 49 ++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 48 insertions(+), 1 deletion(-)

diff --git a/README_mac.txt b/README_mac.txt
index 08888d9..8c2520c 100644
--- a/README_mac.txt
+++ b/README_mac.txt
@@ -4,5 +4,52 @@ This file explains the installation of Vim on Macintosh systems.
See "README.txt" for general information about Vim.


-Sorry, this text still needs to be written!
+VIM ON MAC OS X
+
+On Mac OS X there are two flavors of Vim. Compiling from this source will
+create a terminal based version of Vim like any other Unix like environment.
+There is a separate project called MacVim which uses the same source base but
+compiles a Mac OS X native application that is installed in your
+"/Applications" folder.
+
+If you wish to have a native GUI for the Mac please take a look at the MacVim
+project at https://github.com/macvim-dev/macvim
+
+Both variants can be easily compiled and installed through Homebrew
+(http://brew.sh/).
+
+
+HOW TO BUILD AND INSTALL
+
+If you wish to compile Vim (the terminal version not MacVim) yourself then
+follow these instructions.
+
+Run "./configure" in the "src/" directory with the flags you want (call
+"./configure --help" to see a list of flags) e.g.:
+
+ $ cd src
+ $ ./configure --with-features=huge \
+ --with-tlib=ncurses \
+ --enable-multibyte \
+ --enable-rubyinterp \
+ --enable-pythoninterp \
+ --enable-perlinterp \
+ --enable-cscope
+
+Now build the project using "make":
+
+ $ make
+
+
+CAVEAT
+
+Avoid using "STRIP=true" during the build step. If stripping the binaries is
+enabled, vim will segfault with statically-linked interpreters like ruby
+http://code.google.com/p/vim/issues/detail?id=114&thanks=114&ts=1361483471
+
+Finally you can install Vim to the system with:
+
+ $ make install
+
+The install step CAN use the "STRIP=true" if you wish.

--
2.4.5


--
PGP Key: DE767C8A / FA9F 1400 8BA5 A847 B097 7C06 EBD9 9C92 DE76 7C8A
http://tritarget.org/key

[Janusz Bossy]

On Tue, Oct 13, 2015, at 21:49, Devin Weaver wrote:
> Bram asked me to post this here for code review. Anyone ok taking a
> gander at this? I'll collect and address comments before telling Bram it
> is ok to merge this on vim-dev. Thanks.

Looks really good. Great job!

/Janusz Bossy