README.markdown

   1 NetBeans Git Module
   2 ===================
   3
   4 Note
   5 ----
   6
   7 ### Official Oracle-developed Plugin
   8
   9 Oracle have now begun development of an official NetBeans Git plugin. You can
  10 follow the development of this plugin on the NetBeans wiki:
  11
  12  - <http://netbeans.org/projects/versioncontrol/pages/Git_main>
  13
  14 You can also subscribe to the mailing list for more detailed discussion of the
  15 plugin's development:
  16
  17  -  git@versioncontrol.netbeans.org
  18
  19 Code for the plugin has already landed in the NetBeans "silver" repository.
  20 Unfortunately, NetBeans and official plugins are not developed with Git, but
  21 with Mercurial (hg). To clone the repository:
  22
  23     hg clone http://hg.netbeans.org/main-silver/
  24
  25 Please note: the repository is large and cloning can take a considerable amount
  26 of time.
  27
  28 Introduction
  29 ------------
  30
  31 A versioning plugin for working with Git repositories in Netbeans. Presently,
  32 it supports the basic tasks of status, diff, commit, and log viewing. Future
  33 versions will increase functionality to provide a full set of 'porcelain'
  34 commands.
  35
  36 It uses the JGit library for accessing repositories. To ease installation
  37 a JGit jar is distributed with the project source in release/modules/ext/.
  38
  39 More information and documentation are available in the form of JavaHelp files
  40 which can be found under:
  41
  42   - javahelp/org/nbgit/docs/
  43
  44 They will also be accessible via the Help menu when the plugin has been
  45 installed.
  46
  47 To download the latest version, check the current status of development, or
  48 report an issue visit the project page at:
  49
  50  - <http://nbgit.googlecode.com/>
  51
  52 Installation
  53 ------------
  54
  55 This module is still under development and thus may randomly crash, eat
  56 all your memory, etc. So consider yourself warned! Before installing or
  57 upgrading make sure you read the release notes and list of known issues.
  58 They can be found in:
  59
  60  - javahelp/org/nbgit/docs/news.html
  61  - javahelp/org/nbgit/docs/issues.html
  62
  63 To install from source you need to install the "NetBeans Plugin Development"
  64 plugin from the plugins menu. Afterwards clone the repository and use
  65 File > Open Project to add it to your project list in Netbeans. Then right
  66 click on the new project and select "Install/Reload in Development IDE". You
  67 are advised to first test the plugin by "running" the project.
  68
  69 Getting the Source
  70 ------------------
  71
  72 Performing a git clone on either of the following repositories will get you
  73 the latest source:
  74
  75     git clone git://github.com/myabc/nbgit.git
  76     git clone git://gitorious.org/nbgit/mainline.git (on gitorious)
  77
  78 The following additional mirrors are available:
  79
  80     git://repo.or.cz/nbgit.git
  81     http://repo.or.cz/r/nbgit.git
  82
  83 Licensing and Copyright
  84 -----------------------
  85
  86 This code is dual-licensed under the **COMMON DEVELOPMENT AND DISTRIBUTION
  87 LICENSE (CDDL) Version 1.0** and the **GNU Public License (GPL) v2**. Please see
  88 LICENSE for licensing and copyright information.
  89
  90 Support
  91 -------
  92
  93  * **nbgit**: <http://nbgit.org/>
  94  * **nbgit Mailing List**: <http://groups.google.com/group/nbgit>