update readme to be markdown based
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 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c0416f6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,213 @@
+libgit2 - the Git linkable library
+======================
+
+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.
+
+Why Do We Need It
+=======================
+
+In the current Git project, though a libgit.a file is produced it is
+not re-entrant (it will call <code>die()</code> on basically any error)
+and it has no stable or well-designed public API. As there is no good
+way to link to this effectively, a new library was needed that fulfilled
+these requirements. Thus libgit2.
+
+Though it would be nice to use the same library that Git itself uses,
+Git actually has a pretty simple storage format and just having native
+access to that is pretty useful. Eventually we would like to have most
+of the functionality of the core Git tools or even get the library
+integrated into Git itself, but in the meantime having a cleanly designed
+and maintained linkable Git library with a public API will likely be helpful
+to lots of people.
+
+What It Can Do
+==================================
+
+libgit2 is already very usable.
+
+* raw <-> hex SHA conversions
+* raw object reading (loose and packed)
+* raw object writing (loose)
+* revlist walker
+* commit, tag and tree object parsing and write-back
+* tree traversal
+* basic index file (staging area) operations
+
+Building libgit2 - Unix systems
+==================================
+
+In Unix-like systems, like Linux, *BSD and Mac OS X, libgit2 has
+the following dependencies:
+
+* Python 2.5-3.1 <http://www.python.org>
+ Used by run the build system; no extra libraries required.
+ Should probably ship installed with your OS.
+
+* zlib 1.2+ <http://www.zlib.net/>
+
+* LibSSL <http://www.openssl.org/>
+ Only needed if you want to re-use OpenSSL's SHA1 routines;
+ libgit2 compiles its own routines by default.
+
+To build it, first configure the build system by running:
+
+ $ ./waf configure
+
+Then build the library, either in its shared (libgit2.so) or static form (libgit2.a)
+
+ $ ./waf build-static
+ $ ./waf build-shared
+
+You can then test the library with:
+
+ $ ./waf test
+
+And finally you can install it with (you may need to sudo):
+
+ $ ./waf install
+
+Building libgit2 - Windows MSVC++
+==================================
+
+When building under Windows using the MSVC compiler, libgit2 has
+the following dependencies:
+
+* Python 2.5-3.1 <http://www.python.org>
+ Used by run the build system; no extra libraries required.
+
+* zlib 1.2+ (Windows API Version) <http://www.zlib.net/>
+ Make sure you compile the ZLib library using the MSVC solution
+ that ships in its source distribution.
+ Alternatively, you may download precompiled binaries from:
+ http://www.winimage.com/zLibDll/
+
+* LibSSL <http://www.openssl.org/>
+ Only needed if you want to re-use OpenSSL's SHA1 routines;
+ libgit2 compiles its own routines by default.
+
+To build it, first configure the build system by running:
+
+ $ ./waf configure
+
+Then build the library, either in its shared (libgit2.dll) or static form (libgit2.lib)
+
+ $ ./waf build-static
+ $ ./waf build-shared
+
+You can then test the library with:
+
+ $ ./waf test
+
+Lastly, you can manually install the generated *.lib and *.dll files, depending on
+your preferences.
+
+Building libgit2 - Windows MinGW
+==================================
+
+When building under Windows using the GCC compiler that ships with MinGW,
+libgit2 has the following dependencies:
+
+* Python 2.5-3.1 <http://www.python.org>
+ Used by run the build system; no extra libraries required.
+
+* zlib 1.2+ <http://www.zlib.net/>
+
+* pthreads-w32 <http://sourceware.org/pthreads-win32/>
+ Or an equivalent pthreads implementation for non-POSIX systems
+
+* LibSSL <http://www.openssl.org/>
+ Only needed if you want to re-use OpenSSL's SHA1 routines;
+ libgit2 compiles its own routines by default.
+
+To build it, first configure the build system and force GCC as the compiler,
+instead of the default MSVC:
+
+ $ ./waf configure --check-c-compiler=gcc
+
+Then build the library, either in its shared (libgit2.so) or static form (libgit2.a)
+
+ $ ./waf build-static
+ $ ./waf build-shared
+
+You can then test the library with:
+
+ $ ./waf test
+
+And finally you can install it with:
+
+ $ ./waf install
+
+
+Configuration settings
+==================================
+
+The waf build system for libgit2 accepts the following flags:
+
+ --debug
+ build the library with debug symbols.
+ Defaults to off.
+
+ --sha1=[builtin|ppc|openssl]
+ use the builtin SHA1 functions, the optimized PPC versions
+ or the SHA1 functions from LibCrypto (OpenSSL).
+ Defaults to 'builtin'.
+
+You can run `./waf --help` to see a full list of install options and
+targets.
+
+Language Bindings
+==================================
+
+So you want to use Git from your favorite programming language. Here are
+the bindings to libgit2 that are currently available:
+
+Ruby
+--------------------
+
+Rugged is the reference library used to make sure the
+libgit2 API is sane. This should be mostly up to date.
+
+[[https://github.com/libgit2/rugged]]
+
+
+Python
+--------------------
+
+Pygit2 is a Python binding to libgit2.
+
+[[https://github.com/libgit2/pygit2]]
+
+Erlang
+--------------------
+
+Geef is an example of an Erlang NIF binding to libgit2. A bit out of
+date, but basically works. Best as a proof of concept of what you could
+do with Erlang and NIFs with libgit2.
+
+[[https://github.com/schacon/geef]]
+
+If you start another language binding to libgit2, please let us know so
+we can add it to the list.
+
+How Can I Contribute
+==================================
+
+Fork libgit2/libgit2 on GitHub, add your improvement, push it to a branch
+in your fork named for the topic, send a pull request.
+
+You can also file bugs or feature requests under the libgit2 project on
+GitHub, or join us on the mailing list by sending an email to:
+
+libgit2@librelist.com
+
+
+License
+==================================
+libgit2 is under GPL2 with linking exemption, which basically means you
+can link to the library with any program, commercial, open source or
+other. However, you cannot modify libgit2 and distribute it without
+supplying the source.
+
+See the COPYING file for the full license text.
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 876e592..0000000
--- a/README.txt
+++ /dev/null
@@ -1,192 +0,0 @@
-libgit2 - the Git linkable library
-==================================
-
-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.
-
-Why Do We Need It
-==================================
-
-In the current Git project, though a libgit.a file is produced it is
-not re-entrant (it will call <code>die()</code> on basically any error)
-and it has no stable or well-designed public API. As there is no good
-way to link to this effectively, a new library was needed that fulfilled
-these requirements. Thus libgit2.
-
-Though it would be nice to use the same library that Git itself uses,
-Git actually has a pretty simple storage format and just having native
-access to that is pretty useful. Eventually we would like to have most
-of the functionality of the core Git tools or even get the library
-integrated into Git itself, but in the meantime having a cleanly designed
-and maintained linkable Git library with a public API will likely be helpful
-to lots of people.
-
-What It Can Do
-==================================
-
-libgit2 is already very usable.
-* raw <-> hex SHA conversions
-* raw object reading (loose and packed)
-* raw object writing (loose)
-* revlist walker
-* commit, tag and tree object parsing and write-back
-* tree traversal
-* basic index file (staging area) operations
-
-Building libgit2 - Unix systems
-==================================
-
-In Unix-like systems, like Linux, *BSD and Mac OS X, libgit2 has
-the following dependencies:
-
- - Python 2.5-3.1 <http://www.python.org>
- Used by run the build system; no extra libraries required.
- Should probably ship installed with your OS.
-
- - zlib 1.2+ <http://www.zlib.net/>
-
- - LibSSL <http://www.openssl.org/>
- Only needed if you want to re-use OpenSSL's SHA1 routines;
- libgit2 compiles its own routines by default.
-
-To build it, first configure the build system by running:
-
- $ ./waf configure
-
-Then build the library, either in its shared (libgit2.so) or static form (libgit2.a)
-
- $ ./waf build-static
- $ ./waf build-shared
-
-You can then test the library with:
-
- $ ./waf test
-
-And finally you can install it with (you may need to sudo):
-
- $ ./waf install
-
-Building libgit2 - Windows MSVC++
-==================================
-
-When building under Windows using the MSVC compiler, libgit2 has
-the following dependencies:
-
- - Python 2.5-3.1 <http://www.python.org>
- Used by run the build system; no extra libraries required.
-
- - zlib 1.2+ (Windows API Version) <http://www.zlib.net/>
- Make sure you compile the ZLib library using the MSVC solution
- that ships in its source distribution.
- Alternatively, you may download precompiled binaries from:
- http://www.winimage.com/zLibDll/
-
- - LibSSL <http://www.openssl.org/>
- Only needed if you want to re-use OpenSSL's SHA1 routines;
- libgit2 compiles its own routines by default.
-
-To build it, first configure the build system by running:
-
- $ ./waf configure
-
-Then build the library, either in its shared (libgit2.dll) or static form (libgit2.lib)
-
- $ ./waf build-static
- $ ./waf build-shared
-
-You can then test the library with:
-
- $ ./waf test
-
-Lastly, you can manually install the generated *.lib and *.dll files, depending on
-your preferences.
-
-Building libgit2 - Windows MinGW
-==================================
-
-When building under Windows using the GCC compiler that ships with MinGW,
-libgit2 has the following dependencies:
-
- - Python 2.5-3.1 <http://www.python.org>
- Used by run the build system; no extra libraries required.
-
- - zlib 1.2+ <http://www.zlib.net/>
-
- - pthreads-w32 <http://sourceware.org/pthreads-win32/>
- Or an equivalent pthreads implementation for non-POSIX systems
-
- - LibSSL <http://www.openssl.org/>
- Only needed if you want to re-use OpenSSL's SHA1 routines;
- libgit2 compiles its own routines by default.
-
-To build it, first configure the build system and force GCC as the compiler,
-instead of the default MSVC:
-
- $ ./waf configure --check-c-compiler=gcc
-
-Then build the library, either in its shared (libgit2.so) or static form (libgit2.a)
-
- $ ./waf build-static
- $ ./waf build-shared
-
-You can then test the library with:
-
- $ ./waf test
-
-And finally you can install it with:
-
- $ ./waf install
-
-
-Configuration settings
-==================================
-
-The waf build system for libgit2 accepts the following flags:
-
- --debug
- build the library with debug symbols.
- Defaults to off.
-
- --sha1=[builtin|ppc|openssl]
- use the builtin SHA1 functions, the optimized PPC versions
- or the SHA1 functions from LibCrypto (OpenSSL).
- Defaults to 'builtin'.
-
-You can run `./waf --help` to see a full list of install options and
-targets.
-
-Language Bindings
-==================================
-
-So you want to use Git from your favorite programming language. Here are
-the bindings to libgit2 that are currently available:
-
-== Ruby ==
-
-Ribbit is the reference library used to make sure the
-libgit2 API is sane. This should be mostly up to date.
-
-http://github.com/libgit2/ribbit
-
-
-== Erlang ==
-
-Geef is an example of an Erlang NIF binding to libgit2. A bit out of
-date, but basically works. Best as a proof of concept of what you could
-do with Erlang and NIFs with libgit2.
-
-http://github.com/schacon/geef
-
-
-If you start another language binding to libgit2, please let us know so
-we can add it to the list.
-
-License
-==================================
-libgit2 is under GPL2 with linking exemption, which basically means you
-can link to the library with any program, commercial, open source or
-other. However, you cannot modify libgit2 and distribute it without
-supplying the source.
-
-See the COPYING file for the full license text.