doc/getting.txt

   1 Appendix C: Getting ZynAddSubFX
   2 -------------------------------
   3
   4 Usually there are several methods to obtain a copy of ZynAddSubFX.
   5
   6 SourceForge::
   7     https://sourceforge.net/projects/zynaddsubfx/files/
   8 Distribution::
   9     apt/yum/others
  10 Git::
  11     git clone git://git.code.sf.net/p/zynaddsubfx/code zynaddsubfx
  12
  13 Introduction to Git
  14 ~~~~~~~~~~~~~~~~~~~
  15
  16 For those who want to live on the bleeding edge or who want to assist with
  17 making sure that the next release has fewer bugs, you will want to get acquainted
  18 with git.
  19 Git is used to manage the source code for this project and can be used to
  20 quickly and easily get an up-to-date copy of the source code.
  21
  22 Getting the Source Code
  23 ^^^^^^^^^^^^^^^^^^^^^^^
  24
  25 In order to get a copy of the ZynAddSubFX source code, all that needs to be done is:
  26
  27 ---------------------------------------------
  28 git clone git://git.code.sf.net/p/zynaddsubfx/code zynaddsubfx
  29
  30 cd zynaddsubfx
  31
  32 #Download additional resources
  33 git submodule init
  34 git submodule update
  35 ---------------------------------------------
  36
  37 You should now be in the directory of the source code.
  38
  39 For simple steps on building, please see Appendix B of the manual.
  40
  41 Checking out a branch
  42 ^^^^^^^^^^^^^^^^^^^^^
  43
  44 Lets say that development has extended into the creation of a new feature that
  45 you want to preview.
  46 For the sake of this guide, lets assume that the name of the branch that the
  47 feature is on is foo.
  48
  49 -----------------------------------------
  50 #checkout the foo branch from sourceforge
  51 git checkout --track -b foo origin/foo
  52
  53 #lets checkout the primary branch again
  54 git checkout master
  55
  56 #hop back to the other branch
  57 git checkout foo
  58 ----------------------------------------
  59
  60 Now one should be able to change branches and go into the build directory (as
  61 described in Appendix B) and recompile ZynAddSubFX.
  62
  63 NOTE: When using branches other than the master be aware that stability may
  64       suffer
  65