README.markdown

   1 NetBeans Git Module README
   2 ==========================
   3
   4 A NetBeans Module to provide first-class support for the Git version control
   5 system in the NetBeans IDE.
   6
   7 This module currently targets NetBeans 6.1 and above.
   8
   9 The code is ported directly from the Mercurial Module (included as part of the
  10 NetBeans core distribution, as of NetBeans 6.1).
  11
  12 Pre-Requisites
  13 --------------
  14
  15  * Install Git (version 1.5.6 or 1.6.0):
  16   * on OS X / Linux / Solaris, install from Source:  http://git.or.cz/
  17   * on Windows, install the binaries using MSys Git: http://code.google.com/p/msysgit/
  18
  19 Warning
  20 -------
  21
  22 **PLEASE READ BEFORE DOWNLOADING**
  23 As of 19 August 2008, this Module is under **heavy development** and is not yet
  24 suitable for end-users who want Git functionality within NetBeans. If you've
  25 got NetBeans and Java experience, please feel clone, download, and experiment.
  26 *If you're looking for a working NetBeans module, this project is not there yet!
  27 Please consider joining the mailing list to stay in touch!*
  28
  29 Getting the Source
  30 ------------------
  31
  32 Performing a git clone on either of the following repositories will get you
  33 the latest source:
  34
  35     git clone git://github.com/myabc/nbgit.git
  36     git clone git://gitorious.org/nbgit/mainline.git (on gitorious)
  37
  38 The following additional mirrors are available:
  39
  40     git://repo.or.cz/nbgit.git
  41     http://repo.or.cz/r/nbgit.git
  42
  43 Build Instructions
  44 ------------------
  45
  46 Please see here: <http://github.com/myabc/nbgit/wikis/buildinstructions>
  47
  48 Licensing and Copyright
  49 -----------------------
  50
  51 This code is licensed under the **GNU Public License (GPL) v2**. Please see
  52 LICENSE for licensing and copyright information.
  53
  54 Support
  55 -------
  56
  57 This Module is under heavy development. No official support is currently
  58 provided.
  59
  60  * **NetBeans Git mailing list**: <http://groups.google.com/group/nbgit>
  61  * **NetBeans Git homepage**: <http://trac.ikonoklastik.com/nbgit/>
  62  * Contact the developers directly:
  63    - <alex@alexcolesportfolio.com> | myabc on #datamapper, #merb IRC