README.markdown

   1 NetBeans Git Module
   2 ===================
   3
   4 A versioning plugin for working with Git repositories in Netbeans. Presently,
   5 it supports the basic tasks of status, diff, commit, and log viewing. Future
   6 versions will increase functionality to provide a full set of 'porcelain'
   7 commands.
   8
   9 It uses the JGit library for accessing repositories. To ease installation
  10 a JGit jar is distributed with the project source in release/modules/ext/.
  11
  12 More information and documentation are available in the form of JavaHelp files
  13 which can be found under:
  14
  15   - javahelp/org/nbgit/docs/
  16
  17 They will also be accessible via the Help menu when the plugin has been
  18 installed.
  19
  20 To download the latest version, check the current status of development, or
  21 report an issue visit the project page at:
  22
  23  - <http://nbgit.googlecode.com/>
  24
  25 Installation
  26 ------------
  27
  28 This module is still under development and thus may randomly crash, eat
  29 all your memory, etc. So consider yourself warned! Before installing or
  30 upgrading make sure you read the release notes and list of known issues.
  31 They can be found in:
  32
  33  - javahelp/org/nbgit/docs/news.html
  34  - javahelp/org/nbgit/docs/issues.html
  35
  36 To install from source clone the repository and use File > Open Project to
  37 add it to your project list in Netbeans. Then right click on the new project
  38 and select "Install/Reload in Development IDE". You are advised to first test
  39 the plugin by "running" the project.
  40
  41 Getting the Source
  42 ------------------
  43
  44 Performing a git clone on either of the following repositories will get you
  45 the latest source:
  46
  47     git clone git://github.com/myabc/nbgit.git
  48     git clone git://gitorious.org/nbgit/mainline.git (on gitorious)
  49
  50 The following additional mirrors are available:
  51
  52     git://repo.or.cz/nbgit.git
  53     http://repo.or.cz/r/nbgit.git
  54
  55 Licensing and Copyright
  56 -----------------------
  57
  58 This code is dual-licensed under the **COMMON DEVELOPMENT AND DISTRIBUTION
  59 LICENSE (CDDL) Version 1.0** and the **GNU Public License (GPL) v2**. Please see
  60 LICENSE for licensing and copyright information.
  61
  62 Support
  63 -------
  64
  65  * **nbgit**: <http://nbgit.org/>
  66  * **nbgit Mailing List**: <http://groups.google.com/group/nbgit>