diff options
author | Edward Thomson <ethomson@edwardthomson.com> | 2017-11-12 13:05:59 +0000 |
---|---|---|
committer | Edward Thomson <ethomson@edwardthomson.com> | 2017-11-24 22:24:43 +0000 |
commit | 9e91a989f81f1f80b551c2398cfa9739e6740b0a (patch) | |
tree | 35ecda8f5a0667180f2de10cb4f8ca46723ffc83 /README.md | |
parent | dc985353cfaca434b8a712c1186b6dbbc8c4dba3 (diff) | |
download | libgit2-9e91a989f81f1f80b551c2398cfa9739e6740b0a.tar.gz |
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.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 24 |
1 files changed, 24 insertions, 0 deletions
@@ -15,6 +15,30 @@ with any kind of software without having to release its source code. Additionally, the example code has been released to the public domain (see the [separate license](examples/COPYING) for more information). +Quick Start +=========== + +**Prerequisites** for building libgit2: + +1. [CMake](https://cmake.org/), and is recommended to be installed into + your `PATH`. +2. [Python](https://www.python.org) is used by our test framework, and + should be installed into your `PATH`. +3. C compiler: libgit2 is C90 and should compile on most compilers. + * Windows: Visual Studio is recommended + * Mac: Xcode is recommended + * Unix: gcc or clang is recommended. + +**Build** + +1. Create a build directory beneath the libgit2 source directory, and change + into it: `mkdir build && cd build` +2. Create the cmake build environment: `cmake ..` +3. Build libgit2: `cmake --build .` + +Trouble with these steps? Read `TROUBLESHOOTING.md`. More detailed build +guidance is available below. + Getting Help ============ |