Skip to content

Commit 9e91a98

Browse files
committed
README: provide quick start paragraph
Provide a very simple quick start paragraph that highlights how easy it is to get started, and points people toward common problems.
1 parent dc98535 commit 9e91a98

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,30 @@ with any kind of software without having to release its source code.
1515
Additionally, the example code has been released to the public domain (see the
1616
[separate license](examples/COPYING) for more information).
1717

18+
Quick Start
19+
===========
20+
21+
**Prerequisites** for building libgit2:
22+
23+
1. [CMake](https://cmake.org/), and is recommended to be installed into
24+
your `PATH`.
25+
2. [Python](https://www.python.org) is used by our test framework, and
26+
should be installed into your `PATH`.
27+
3. C compiler: libgit2 is C90 and should compile on most compilers.
28+
* Windows: Visual Studio is recommended
29+
* Mac: Xcode is recommended
30+
* Unix: gcc or clang is recommended.
31+
32+
**Build**
33+
34+
1. Create a build directory beneath the libgit2 source directory, and change
35+
into it: `mkdir build && cd build`
36+
2. Create the cmake build environment: `cmake ..`
37+
3. Build libgit2: `cmake --build .`
38+
39+
Trouble with these steps? Read `TROUBLESHOOTING.md`. More detailed build
40+
guidance is available below.
41+
1842
Getting Help
1943
============
2044

0 commit comments

Comments
 (0)