commit d2a634e8bdd937ca033c84cbf9b841d69d4c7e0e
parent 68e595e03dbf01bd561fc74f910547fae87c3332
Author: fundamental <mark.d.mccurry@gmail.com>
Date: Thu, 4 Mar 2010 09:14:17 -0500
Doc: Adding simple git guide
Diffstat:
3 files changed, 73 insertions(+), 7 deletions(-)
diff --git a/doc/build.txt b/doc/build.txt
@@ -1,5 +1,5 @@
-Building ZynAddSubFX
-====================
+Appendix B: Building ZynAddSubFX
+================================
Introduction to CMake
---------------------
@@ -33,6 +33,11 @@ Quick start guide
For the impatient ones, here is a quick guide on how to immediately
build ZynAddSubFX from source.
+
+**************************************************************
+Note: This assumes that you already have a copy of the source.
+**************************************************************
+
---------------------------------
#enter the source directory
cd zynaddsubfx
@@ -46,13 +51,9 @@ cd build
cmake ..
#OPTIONAL: Adjust compile variables in the Cache file:
-$EDITOR CMakeCache.txt
+ccmake .
#And finally, build as usual using make
make
---------------------------------
-Customizing the build
----------------------
-
-
diff --git a/doc/getting.txt b/doc/getting.txt
@@ -0,0 +1,61 @@
+Appendix C: Getting ZynAddSubFX
+===============================
+
+Usually there are several methods to obtain a copy of ZynAddSubFX.
+
+SourceForge::
+ http://sourceforge.net/projects/zynaddsubfx/files/
+Distribuition::
+ apt/yum/others
+Git::
+ git://zynaddsubfx.git.sourceforge.net/gitroot/zynaddsubfx/zynaddsubfx
+
+Introduction to Git
+-------------------
+
+For those who want to live on the bleeding edge or who want to assist with
+making sure that the next release has fewer bugs, you will want to get aquanted
+with git.
+Git is used to manage the source code for this project and can be used to
+quickly and easily get an up-to-date copy of the source code.
+
+Getting the Source Code
+~~~~~~~~~~~~~~~~~~~~~~~
+
+In order to get a copy of the ZynAddSubFX source code, all that needs to be done is:
+
+---------------------------------------------
+git clone git://zynaddsubfx.git.sourceforge.net/gitroot/zynaddsubfx/zynaddsubfx
+
+cd zynaddsubfx
+---------------------------------------------
+
+You should now be in the directory of the source code.
+
+For simple steps on building, please see Appendix B of the manual.
+
+Checking out a branch
+~~~~~~~~~~~~~~~~~~~~~
+
+Lets say that development has extended into the creation of a new feature that
+you want to preview.
+For the sake of this guide, lets assume that the name of the branch that the
+feature is on is foo.
+
+-----------------------------------------
+#checkout the foo branch from sourceforge
+git checkout --track -b foo origin/foo
+
+#lets checkout the primary branch again
+git checkout master
+
+#hop back to the other branch
+git checkout foo
+----------------------------------------
+
+Now one should be able to change branches and go into the build directory (as
+described in Appendix B) and recompile ZynAddSubFX.
+
+NOTE: When using branches other than the master be aware that stability may
+ suffer
+
diff --git a/doc/zynaddsubfx.txt b/doc/zynaddsubfx.txt
@@ -18,3 +18,7 @@ include::./controller.txt[]
include::./nrpn.txt[]
include::./mididefaults.txt[]
+
+include::./build.txt[]
+
+include::./getting.txt[]
