|author||Robin Stocker||2012-09-08 13:58:37 (EDT)|
|committer||Robin Stocker||2012-09-08 13:58:37 (EDT)|
|commit||6b74aff641dd5366a7c13315f25b5f85816fe17e (patch) (side-by-side diff)|
README: Convert to Markdown and rename to README.mdrefs/changes/92/7692/1
This makes it display nicely on the GitHub mirror repository. And it is still very pleasant to read in plain text. Change-Id: I0c5e1caa58a22684cdbd9a02e9ec38e97d5adb1a Signed-off-by: Robin Stocker <email@example.com>
|-rw-r--r--||README.md (renamed from README)||36|
1 files changed, 24 insertions, 12 deletions
@@ -1,22 +1,26 @@
- == Java GIT ==
This package is licensed under the EDL (Eclipse Distribution
A pure Java library capable of being run standalone, with no
additional support libraries. Some JUnit tests are provided
to exercise the library. The library provides functions to
- read and write a GIT formatted repository.
+ read and write a Git formatted repository.
All portions of jgit are covered by the EDL. Absolutely no GPL,
LGPL or EPL contributions are accepted within this package.
Unit tests for org.eclipse.jgit and the same licensing rules.
- == WARNINGS / CAVEATS ==
- Symbolic links are not supported because java does not support it.
Such links could be damaged.
@@ -48,9 +52,11 @@ License).
- We try to use the same notation of $HOME as C Git does. On Windows
this is often not same value as the user.home system property.
- == Package Features ==
* Read loose and packed commits, trees, blobs, including
@@ -85,12 +91,14 @@ License).
Push via ssh, git and Amazon S3. JGit does not yet deltify
the pushed packs so they may be a lot larger than C Git packs.
* Assorted set of command line utilities. Mostly for ad-hoc testing of jgit
log, glog, fetch etc.
- == Missing Features ==
There are a lot of missing features. You need the real Git for this.
For some operations it may just be the preferred solution also. There
@@ -114,18 +122,22 @@ partial files simple.
- submodule support
Submodules are not supported or even recognized.
- == Support ==
Post question, comments or patches to the firstname.lastname@example.org mailing list.
- == Contributing ==
See SUBMITTING_PATCHES in this directory. However, feedback and bug reports
are also contributions.
- == About GIT ==
More information about GIT, its repository format, and the canonical
C based implementation can be obtained from the GIT websites: