
               Subcommander, yet another Subversion client.
               ============================================

$LastChangedDate: 2009-01-18 01:53:12 -0800 (Sun, 18 Jan 2009) $


Contents:

     I. Introduction
    II. Quickstart
        1. Installation
        2. Documentation
   III. Sources, Binaries


I.   Introduction

     The goal of the  Subcommander project is to  build an easy to  use,
     crossplatform (Win32, Unix, MacOSX) Subversion gui client including
     a graphical diff and merge tool for text files.

     The Subversion gui client is called subcommander and the merge tool
     is called submerge.

     The project web site is located at http://subcommander.tigris.org.


     Subversion
     ----------
     
     Subversion is a  version control system  similar to CVS.   For more
     information on Subversion point your web browser to subversions web
     site at http://subversion.tigris.org.
     
     
     Feedback, Bugs, Features, Questions
     -----------------------------------

     Please direct any  feedback, bug reports  or feature request to the
     subcommander mailing list

                      dev@subcommander.tigris.org
     
     
     You can also use the web interface at
     
     http://subcommander.tigris.org/ds/viewForumSummary.do?dsForumId=2037  
     
     to read or post to the mailing list.
     

     To subscribe to the list send an email to:
     
                  dev-subscribe@subcommander.tigris.org
    
    
     I have also started a Subcommander FAQ at
     
                 http://subcommander.tigris.org/wiki/faq
     
     
     and a Subcommander blog at
     
                  http://subcommanderblog.wordpress.com
     
     
 II. Quickstart

     1. Installation:
     ================
     
     The  notes  here  assume  that you  want  to  install  the prebuild
     Subcommander binaries  for Windows  or MacOSX.  On Unix you have to
     build Subcommander from source. See the INSTALL file.
     
     Win32:
     ------

     Subcommander-x.y.z.exe is a typical win32 installer. Simply run it
     and  answer  the  questions  (installation  dir etc.)   to install
     Subcommander on your system.

     
     MacOSX:
     -------
     
     The  Subcommander-x.y.z.dmg contains  a subcommander  bundle and  a
     submerge bundle. You can simply install them by drag and drop.
     
     Note that subcommander will  only find submerge  if it is installed
     in the same folder as subcommander.

     
     Unix:
     -----

     Several Linux distributions offer prebuild binary packages  you can
     install using your systems package manager.
     
     If you system does not have a Subcommander package you can build it
     from the source archive with the typical  'configure',  'make'  and
     'make install' commands. See the INSTALL file for more information.
     
     
     
     2. Documentation:
     =================

     The  main  documentation  is  the  Subcommander User Guide.  Its is
     included in the  binary distributions or  you  can get  it from the
     Subcommander web site.
     
     Anyway, here is a short introduction to get you going:
    
     To  control a subversion urls and working copies from  subcommander
     you  need project.  A  subcommander project is  used  to  group the
     most  important urls  of a  project  repository  and any  number of
     working copies together.
     
     By setting the special 'branches' and 'tags' URLs for a project you
     will  never have  to enter  the URL  to your  'branches' or  'tags'
     folder in the repository again. Not that the folders do not have to
     be named  'branches' and  'tags'.  subcommander only needs  to know
     where you keep  the branches and  tags in the  repository. When you
     create a branch  or tag simply   give a name for the branch  or tag
     and   subcommander will   create it  in the   configured folder.  A
     third URL  you  can  enter is  the 'trunk'   URL which is  normally
     used to  point to the  location  where the  main development  takes
     place. 
     
     You can create subcommander projects  using the project setup wizard
     or by drag and drop.
     
     After creating a new project you can add, edit or delete repository
     or  working  copy copy  bookmarks  from the  bookmark  menu or  the
     project context menus.
         
     New Project, Drag and Drop:
     
     To create a new project drop an  url or a working copy path from  a
     web browser  or file  browser  into the empty space of  the project
     folder view on the left of the subcommander main window.
     
     subcommander  creates  a  new  project   and  asks  what  kind   of
     url/path  you    have     dropped  into subcommander   (a  'trunk',
     'branches',  'tags'  or repository URL or a working copy). In   the
     same  way  you  can   modify    a project   by   dropping  URLs  or
     working copies on an existing project.

     To change the name of a subcommander  project you can directly edit
     its name in place by selecting and left clicking it. You can modify
     the project items (repository or working copy bookmark) in the same
     way.

     New Project, Menu:
     
     Selecting "New Project" from the "Project" creates a new project in
     the project folder  view and changes  to in place  edit so you  can
     easily set the  project name. You  can then use the project context
     menu to add repositories or working copies.
     
     
     Bookmark View:
     
     Your new project will appear in the bookmark view on the left side.
     When you open the project you will see the bookmarks you have added
     to the  project. Clicking  one of  the bookmarks   will browse  the
     repository  at  the  given  location  or show  the   status of  the
     working copy at the given path.
     
     Refreshing the Display:
     
     To refresh  the status  display of  a working  copy after changing,
     adding or deleting an  item select a folder  and press  'r' or  the
     refresh button  in  the  tool bar  to refresh  that folder  and its
     children.
     
     Diffs:
     
     To view the differenes on a modified file run diff from the context
     menu. subcommander will  run  submerge (Subcommanders  visual  diff
     and  merge program) to display  the original file and the  modified
     version side by side.

     Checkout:
     
     To checkout a new working copy from a repository select  'checkout'
     from the context menu of a repository entry.

     For more  detailed information  take a  look into  the Subcommander
     User Guide.


III. Sources, Binaries

     You will find subcommander binaries or source archives at:
     
     http://subcommander.tigris.org/servlets/ProjectDocumentList
     

     The archives are named like this:


      * subcommander-x.y.z.exe
       
        win32 installer for the version x.y.z binaries.


      * subcommander-x.y.z.dmg
      
        MacOSX disk image with subcomander and submerge x.y.z bundels.
                         

     *  subcommander-x.y.z.tgz
     
        the source for unix, linux, macosx or windows builds.  Including
        configure script and visual studio project files.
