added install-wrapper script and updated instructions

Author: gyepisam

README.md

@@ -9,7 +9,7 @@ Welcome To Gitdown
 
 Gitdown is a simple tool for writing documentation hosted on a github repository.  It uses [ditaa][] to convert ascii diagrams into images, and produces [markdown][] documents that can be uploaded to your repository along with code.  I made Gitdown so that we could write technical white papers and user guides as plain text (including diagrams) and publish them with a single "git push" command.  Gitdown is a simpler version of the tool we use to maintain the [ØMQ][zeromq] [Guide][zguide].
 
-Gitdown is written and maintained by Pieter Hintjens.  Please use the issue [tracker][] for all comments and errata.  This document was published on Tuesday February, 2013 at 16:43:34, and generated by the magic of Gitdown from README.txt.
+Gitdown is written and maintained by Pieter Hintjens.  Please use the issue [tracker][] for all comments and errata.  This document was published on Tuesday February, 2013 at 19:42:21, and generated by the magic of Gitdown from README.txt.
 
 This is version 2011.03.24 of Gitdown. Changelog:
 
@@ -24,9 +24,9 @@ Contents
 
 &emsp;<a href="#toc2-38">License</a>
 &emsp;<a href="#toc2-47">Installation and Use</a>
-&emsp;<a href="#toc2-72">How it Works</a>
-&emsp;<a href="#toc2-127">Gitdown Syntax Summary</a>
-&emsp;<a href="#toc2-193">Markdown Syntax Summary</a>
+&emsp;<a href="#toc2-79">How it Works</a>
+&emsp;<a href="#toc2-134">Gitdown Syntax Summary</a>
+&emsp;<a href="#toc2-200">Markdown Syntax Summary</a>
 
 <A name="toc2-38" title="License" />
 License
@@ -46,7 +46,14 @@ The code is in the bin subdirectory.  Here is how I install it on a new box:
     sudo cp bin/* /usr/local/bin
     export PERLLIB=$PATH    #   goes into .bash_profile
 
-Gitdown includes Ditaa/0.9 and assumes that Ditaa goes into /usr/local/bin/ditaa0_9.jar.  Feel free to propose a better design.
+Gitdown includes Ditaa/0.9 and assumes that Ditaa goes into /usr/local/bin/ditaa0_9.jar.
+
+Another option is to leave the files in the git directory and install a wrapper script. 
+Assuming the directory ~/bin exists and is in your path, you can do the following:
+
+    make-wrapper ~/bin
+
+to create the file ~/bin/gitdown, which will set things up to run correctly. 
 
 Gitdown assumes that these tools are already installed on your box, which is easy if you're running Linux:
 
@@ -62,7 +69,7 @@ To use Gitdown, edit a text document much like this README.txt.  Then:
 
 The images directory holds images for all documents in the current directory.  You can write documents anywhere on the git tree but if they are not at the root you must tell Gitdown how to create a full image path by setting the SUBDIR symbol (see below).
 
-<A name="toc2-72" title="How it Works" />
+<A name="toc2-79" title="How it Works" />
 How it Works
 ------------
 
@@ -81,7 +88,7 @@ The Gitdown workflow is:
 
 This README acts as an example.
 
-<A name="toc2-127" title="Gitdown Syntax Summary" />
+<A name="toc2-134" title="Gitdown Syntax Summary" />
 Gitdown Syntax Summary
 ---------------------
 
@@ -147,7 +154,7 @@ These symbols are predefined by gitdown for you:
 * SELF specifies the input file name without extension.
 * OUTPUT specifies the current output file name,
 
-<A name="toc2-193" title="Markdown Syntax Summary" />
+<A name="toc2-200" title="Markdown Syntax Summary" />
 Markdown Syntax Summary
 -----------------------
 

README.txt

@@ -49,7 +49,14 @@ The code is in the bin subdirectory.  Here is how I install it on a new box:
     sudo cp bin/* /usr/local/bin
     export PERLLIB=$PATH    #   goes into .bash_profile
 
-Gitdown includes Ditaa/0.9 and assumes that Ditaa goes into /usr/local/bin/ditaa0_9.jar.  Feel free to propose a better design.
+Gitdown includes Ditaa/0.9 and assumes that Ditaa goes into /usr/local/bin/ditaa0_9.jar.
+
+Another option is to leave the files in the git directory and install a wrapper script. 
+Assuming the directory ~/bin exists and is in your path, you can do the following:
+
+    install-wrapper ~/bin
+
+to install the file ~/bin/gitdown, which will set things up to run correctly. 
 
 Gitdown assumes that these tools are already installed on your box, which is easy if you're running Linux:
 

images/README_1.png

@@ -0,0 +1,32 @@
+#!/bin/sh
+
+destdir=$1
+
+if [ -z "$destdir" ] ; then
+    destdir=$HOME/bin
+    if [ -d "$destdir" ]; then
+      echo "installing in default directory: $destdir"
+    else
+      exit
+    fi
+else
+  if ! [ -d "$destdir" ] ; then
+    echo "path [$destdir] is not a directory"
+    exit
+  fi
+fi
+        
+srcdir=$(readlink -f $(dirname $0))
+
+target=$destdir/gitdown
+
+if [ -e "$target" ] ; then
+    echo "file $target already exists!"
+    exit
+fi
+
+cat <<EOS > $target
+#!/bin/sh
+exec env PERLLIB=$srcdir $srcdir/bin/gitdown \$@
+EOS
+chmod +x $target