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

$LastChangedDate: 2006-06-11 11:59:24 +0200 (Sun, 11 Jun 2006) $


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.

     
     Feedback, Participation
     -----------------------

     If you like to  give feedback or  even like to participate  in  the
     project to improve Subcommander  please subscribe to the  developer
     mailing list: 
     
                      dev@subcommander.tigris.org
     

     To subscribe to the list send an email to:
     
                  dev-subscribe@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.
    
     
 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-0.x.y-win32.exe is a typical win32 installer. Just 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:
     -----
     
     Subcommander  currently doesn't  provide  binary  archives for Unix
     systems.  You have to build  Subcommander from the  source  archive
     with  configure,  make and  make install.  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  project (subversion  urls and  working copies)  from
     subcommander  you  need  a  subcommander  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  either by drag and drop or by
     using the "Project" menu.
 
     After creating a new project you can add, edit or delete repository
     or working copy copy bookmarks from the project and the item 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.
     
     
     Project Folder View:
     
     Your new  project will  appear in  the project  folders view on the
     left side. When you open the project you will see the entries   you
     entered in the  "new project" dialog.  Clicking one of  the entries
     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 press  'r' or the refresh button in  the
     tool bar.
     
     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-win32.exe
       
        win32 installer for the version x.y.z binaries.


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


      * subcommander-x.y.z-src.zip 
     
        the source the x.y.z win32 binaries were build  from. The source
        and some other files (README, CHANGES..) with CRLF line endings.
                                      

     *  subcommander-x.y.z-src.tgz
     
        the source for unix, linux or macosx builds. Including configure
        script. Source and some other files  (README, CHANGES..) with LF
        line endings.
