summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRussell Belfer <rb@github.com>2014-02-20 11:26:51 -0800
committerRussell Belfer <rb@github.com>2014-02-20 11:26:51 -0800
commit68a19ca9ffb685123038a8d16c0a59845f147778 (patch)
tree6fc61ee4886564670fc45f32a7d7f62f1712ff4d /README.md
parent978a4ed5ebd3892731434e4023f20383f820c112 (diff)
downloadlibgit2-68a19ca9ffb685123038a8d16c0a59845f147778.tar.gz
Clarify C compatibility policy
and a couple of other minor doc fixups.
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index f814b8732..aa75bb093 100644
--- a/README.md
+++ b/README.md
@@ -20,17 +20,17 @@ Additionally, the example code has been released to the public domain (see the
* API documentation: <http://libgit2.github.com/libgit2>
* 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
+ 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
- the library, or [open an issue](https://github.com/libgit2/libgit2/issues)
- on GitHub for bug reports. The mailing list archives are still available at
+ the library, or [open an issue](https://github.com/libgit2/libgit2/issues)
+ on GitHub for bug reports. The mailing list archives are still available at
<http://librelist.com/browser/libgit2/>.
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
@@ -65,7 +65,7 @@ Under Unix-like systems, like Linux, \*BSD and Mac OS X, libgit2 expects `pthrea
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](<http://www.cmake.org>) (version 2.6 or newer) on all platforms.
On most systems you can build the library using the following commands