Skip to content

Commit e5fd5b9

Browse files
author
Vicent Marti
committed
Update README.md
Fix my broken English. Fix formatting issues in some links. Add new build flag options. Signed-off-by: Vicent Marti <tanoku@gmail.com>
1 parent 8507ab1 commit e5fd5b9

1 file changed

Lines changed: 31 additions & 23 deletions

File tree

‎README.md‎

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,19 @@ libgit2 is already very usable.
3838
Building libgit2 - Unix systems
3939
==================================
4040

41-
In Unix-like systems, like Linux, *BSD and Mac OS X, libgit2 has
41+
In Unix-like systems, like Linux, xBSD and Mac OS X, libgit2 has
4242
the following dependencies:
4343

4444
* Python 2.5-3.1 <http://www.python.org>
45-
Used by run the build system; no extra libraries required.
46-
Should probably ship installed with your OS.
45+
46+
Used to run the build system; no extra libraries required.
47+
Should probably ship installed with your OS.
4748

4849
* zlib 1.2+ <http://www.zlib.net/>
4950

5051
* LibSSL <http://www.openssl.org/>
51-
Only needed if you want to re-use OpenSSL's SHA1 routines;
52-
libgit2 compiles its own routines by default.
52+
53+
Only needed if you want to re-use OpenSSL's SHA1 routines; libgit2 compiles its own routines by default.
5354

5455
To build it, first configure the build system by running:
5556

@@ -75,17 +76,17 @@ When building under Windows using the MSVC compiler, libgit2 has
7576
the following dependencies:
7677

7778
* Python 2.5-3.1 <http://www.python.org>
78-
Used by run the build system; no extra libraries required.
79+
80+
Used to run the build system; no extra libraries required.
7981

8082
* zlib 1.2+ (Windows API Version) <http://www.zlib.net/>
81-
Make sure you compile the ZLib library using the MSVC solution
82-
that ships in its source distribution.
83-
Alternatively, you may download precompiled binaries from:
84-
http://www.winimage.com/zLibDll/
83+
84+
Make sure you compile the ZLib library using the MSVC solution that ships in its source distribution.
85+
Alternatively, you may download precompiled binaries from: <http://www.winimage.com/zLibDll/>
8586

8687
* LibSSL <http://www.openssl.org/>
87-
Only needed if you want to re-use OpenSSL's SHA1 routines;
88-
libgit2 compiles its own routines by default.
88+
89+
Only needed if you want to re-use OpenSSL's SHA1 routines; libgit2 compiles its own routines by default.
8990

9091
To build it, first configure the build system by running:
9192

@@ -100,26 +101,26 @@ You can then test the library with:
100101

101102
$ ./waf test
102103

103-
Lastly, you can manually install the generated *.lib and *.dll files, depending on
104-
your preferences.
104+
Lastly, you can manually install the generated *.lib and *.dll files, depending on your preferences.
105105

106106
Building libgit2 - Windows MinGW
107107
==================================
108108

109-
When building under Windows using the GCC compiler that ships with MinGW,
110-
libgit2 has the following dependencies:
109+
When building under Windows using the GCC compiler that ships with MinGW, libgit2 has the following dependencies:
111110

112111
* Python 2.5-3.1 <http://www.python.org>
113-
Used by run the build system; no extra libraries required.
112+
113+
Used to run the build system; no extra libraries required.
114114

115115
* zlib 1.2+ <http://www.zlib.net/>
116116

117117
* pthreads-w32 <http://sourceware.org/pthreads-win32/>
118-
Or an equivalent pthreads implementation for non-POSIX systems
118+
119+
Or an equivalent pthreads implementation for non-POSIX systems
119120

120121
* LibSSL <http://www.openssl.org/>
121-
Only needed if you want to re-use OpenSSL's SHA1 routines;
122-
libgit2 compiles its own routines by default.
122+
123+
Only needed if you want to re-use OpenSSL's SHA1 routines; libgit2 compiles its own routines by default.
123124

124125
To build it, first configure the build system and force GCC as the compiler,
125126
instead of the default MSVC:
@@ -154,6 +155,13 @@ The waf build system for libgit2 accepts the following flags:
154155
or the SHA1 functions from LibCrypto (OpenSSL).
155156
Defaults to 'builtin'.
156157

158+
--msvc=[7.1|8.0|9.0|10.0]
159+
Force a specific version of the MSVC compiler, if more than
160+
one version is installed.
161+
162+
--arch=[ia64|x64|x86|x86_amd64|x86_ia64]
163+
Force a specific architecture for compilers that support it.
164+
157165
You can run `./waf --help` to see a full list of install options and
158166
targets.
159167

@@ -169,15 +177,15 @@ Ruby
169177
Rugged is the reference library used to make sure the
170178
libgit2 API is sane. This should be mostly up to date.
171179

172-
[[https://github.com/libgit2/rugged]]
180+
<https://github.com/libgit2/rugged>
173181

174182

175183
Python
176184
--------------------
177185

178186
Pygit2 is a Python binding to libgit2.
179187

180-
[[https://github.com/libgit2/pygit2]]
188+
<https://github.com/libgit2/pygit2>
181189

182190
Erlang
183191
--------------------
@@ -186,7 +194,7 @@ Geef is an example of an Erlang NIF binding to libgit2. A bit out of
186194
date, but basically works. Best as a proof of concept of what you could
187195
do with Erlang and NIFs with libgit2.
188196

189-
[[https://github.com/schacon/geef]]
197+
<https://github.com/schacon/geef>
190198

191199
If you start another language binding to libgit2, please let us know so
192200
we can add it to the list.

0 commit comments

Comments
 (0)