Commit 20b5d300dce48ce34c16bf39752fae9a7d05f021
2013-10-17T00:28:08
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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
diff --git a/README.md b/README.md
index 9222f3d..f6d7ccb 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,21 @@
libgit2 - the Git linkable library
-======================
+==================================
[](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: <http://libgit2.github.com>
+* Website: [libgit2.github.com](http://libgit2.github.com)
* StackOverflow Tag: [libgit2](http://stackoverflow.com/questions/tagged/libgit2)
-* Issues: <https://github.com/libgit2/libgit2/issues>
+* Issues: [GitHub Issues](https://github.com/libgit2/libgit2/issues) (Right here!)
* API documentation: <http://libgit2.github.com/libgit2>
-* 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+ (<http://www.cmake.org>) on all platforms.
+The `libgit2` library is built using `CMake 2.6+` (<http://www.cmake.org>) 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.