From 20b5d300dce48ce34c16bf39752fae9a7d05f021 Mon Sep 17 00:00:00 2001 From: Haneef Mubarak Date: Thu, 17 Oct 2013 00:28:08 -0700 Subject: [PATCH 1/3] slightly clarified the "license" portion of `README.md" + formatting all over There are commercial open source applications, hence proprietary seems to be a better term. Also: - Trimmed header `=`'s to match text length - made libgit2 stand out everywhere - pretty printing links - irc link for those with the correct setup --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 9222f3dcf..f6d7ccbc8 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ libgit2 - the Git linkable library -====================== +================================== [![Build Status](https://secure.travis-ci.org/libgit2/libgit2.png?branch=development)](http://travis-ci.org/libgit2/libgit2) -libgit2 is a portable, pure C implementation of the Git core methods provided as a +`libgit2` is a portable, pure C implementation of the Git core methods provided as a re-entrant linkable library with a solid API, allowing you to write native speed custom Git applications in any language with bindings. -libgit2 is licensed under a **very permissive license** (GPLv2 with a special Linking Exception). +`libgit2` is licensed under a **very permissive license** (GPLv2 with a special Linking Exception). This basically means that you can link it (unmodified) with any kind of software without having to release its source code. -* Website: +* Website: [libgit2.github.com](http://libgit2.github.com) * StackOverflow Tag: [libgit2](http://stackoverflow.com/questions/tagged/libgit2) -* Issues: +* Issues: [GitHub Issues](https://github.com/libgit2/libgit2/issues) (Right here!) * API documentation: -* IRC: #libgit2 on irc.freenode.net. +* IRC: [#libgit2](irc://irc.freenode.net/libgit2) on irc.freenode.net. * Mailing list: The libgit2 mailing list was traditionally hosted in Librelist but has been deprecated. We encourage you to [use StackOverflow](http://stackoverflow.com/questions/tagged/libgit2) instead for any questions regarding @@ -25,9 +25,9 @@ release its source code. What It Can Do -================================== +============== -libgit2 is already very usable and is being used in production for many applications including the GitHub.com site, in Plastic SCM +`libgit2` is already very usable and is being used in production for many applications including the GitHub.com site, in Plastic SCM and also powering Microsoft's Visual Studio tools for Git. The library provides: * SHA conversions, formatting and shortening @@ -46,12 +46,12 @@ and also powering Microsoft's Visual Studio tools for Git. The library provides Building libgit2 - Using CMake ============================== -libgit2 builds cleanly on most platforms without any external dependencies. +`libgit2` builds cleanly on most platforms without any external dependencies. Under Unix-like systems, like Linux, \*BSD and Mac OS X, libgit2 expects `pthreads` to be available; they should be installed by default on all systems. Under Windows, libgit2 uses the native Windows API for threading. -The libgit2 library is built using CMake 2.6+ () on all platforms. +The `libgit2` library is built using `CMake 2.6+` () on all platforms. On most systems you can build the library using the following commands @@ -187,9 +187,9 @@ Check the [contribution guidelines](CONTRIBUTING.md). License ================================== -libgit2 is under GPL2 **with linking exemption**. This means you -can link to the library with any program, commercial, open source or -other. However, you cannot modify libgit2 and distribute it without +`libgit2` is under GPL2 **with linking exemption**. This means you +can link to the library with any program, proprietary or open source; paid +or gratis. However, you cannot modify libgit2 and distribute it without supplying the source. See the COPYING file for the full license text. From e5e2710b781a3ebafceb2605f75182637ecfef0b Mon Sep 17 00:00:00 2001 From: Haneef Mubarak Date: Thu, 17 Oct 2013 01:52:20 -0700 Subject: [PATCH 2/3] slightly clarified the "license" portion of `README.md" + formatting all over added the second change suggested by @nulltoken (with two extra words :) ) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f6d7ccbc8..1f5204d13 100644 --- a/README.md +++ b/README.md @@ -188,7 +188,7 @@ Check the [contribution guidelines](CONTRIBUTING.md). License ================================== `libgit2` is under GPL2 **with linking exemption**. This means you -can link to the library with any program, proprietary or open source; paid +can can link to and use the library from any program, proprietary or open source; paid or gratis. However, you cannot modify libgit2 and distribute it without supplying the source. From caf9334115274e48b7eb9c96001037cebc57ad7a Mon Sep 17 00:00:00 2001 From: Haneef Mubarak Date: Thu, 17 Oct 2013 16:01:43 -0700 Subject: [PATCH 3/3] slightly clarified the "license" portion of `README.md" + formatting all over fixed typo `can can` -> `can` --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f5204d13..0d735c397 100644 --- a/README.md +++ b/README.md @@ -188,7 +188,7 @@ Check the [contribution guidelines](CONTRIBUTING.md). License ================================== `libgit2` is under GPL2 **with linking exemption**. This means you -can can link to and use the library from any program, proprietary or open source; paid +can link to and use the library from any program, proprietary or open source; paid or gratis. However, you cannot modify libgit2 and distribute it without supplying the source.