Added warning to make it clear that the module isn't ready just yet.
[nbgit.git] / README.markdown
blob7f41d38dd5c7d93d09d186ff68ba6db2be3c1438
1 NetBeans Git Module README
2 ==========================
4 A NetBeans Module to provide first-class support for the Git version control
5 system in the NetBeans IDE.
7 This module targets NetBeans 6.1 Beta.
9 The code is ported directly from the Mercurial Module (included as part of the 
10 NetBeans core distribution, as of NetBeans 6.1 Beta).
12 Warning
13 -------
15 **PLEASE READ BEFORE DOWNLOADING**
16 As of 15 April 2008, this Module is under **heavy development** and is not yet
17 suitable for end-users who want Git functionality within NetBeans. If you've
18 got NetBeans and Java experience, please feel clone, download, and experiment.
19 *If you're looking for a working NetBeans module, this project is not there yet!
20 Please consider joining the mailing list to stay in touch!*
22 Getting the Source
23 ------------------
25 Performing a git clone on either of the following repositories will get you 
26 the latest source:
28     git clone git://github.com/myabc/nbgit.git
29     git clone git://gitorious.org/nbgit/mainline.git (on gitorious)
31 The following additional mirrors are available:
33     git://repo.or.cz/nbgit.git
34     http://repo.or.cz/r/nbgit.git
36 Licensing and Copyright
37 -----------------------
39 This code is licensed under the **GNU Public License (GPL) v2**. Please see
40 LICENSE for licensing and copyright information.
42 Support
43 -------
45 This Module is under heavy development. No official support is currently 
46 provided.
48 * **NetBeans Git mailing list**:
49    <http://groups.google.com/group/nbgit>
50 * **NetBeans Git homepage**: _coming soon_
51 * Contact the developers directly:
52    - <alex@alexcolesportfolio.com> | myabc on #datamapper, #merb IRC