You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-10Lines changed: 13 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ A brief summary of the available functionality:
18
18
19
19
Not all libgit2 features are available, but if you run across something missing, please consider [contributing a pull request](#contributing)!
20
20
21
-
Many classes in the ObjectiveGit API wrap a C struct from libgit2 and expose the underlying data and operations using Cocoa idioms. The underlying libgit2 types are prefixed with `git_` and are often accessible via a property so that your application can take advantage of the libgit2 API directly.
21
+
Many classes in the ObjectiveGit API wrap a C struct from libgit2 and expose the underlying data and operations using Cocoa idioms. The underlying libgit2 types are prefixed with `git_` and are often accessible via a property so that your application can take advantage of the [libgit2 API](https://libgit2.github.com/libgit2/#HEAD) directly.
22
22
23
23
The ObjectiveGit API makes extensive use of the Cocoa NSError pattern. The public API is also decorated with nullability attributes so that you will get compile-time feedback of whether nil is allowed or not. This also makes the framework much nicer to use in Swift.
24
24
@@ -32,15 +32,18 @@ or download them [manually](#manually).
32
32
33
33
### Other Tools
34
34
35
-
To start building the framework, you must install the required dependencies,
36
-
[xctool](https://github.com/facebook/xctool) and
37
-
[cmake](https://github.com/Kitware/CMake). We recommend using
38
-
[Homebrew](http://brew.sh) to install these tools.
39
-
40
-
Once you have the dependencies you should clone this repository and then run [`script/bootstrap`](script/bootstrap). This will automatically pull down and install any other
41
-
dependencies.
42
-
43
-
Note that the `bootstrap` script automatically installs some libraries that ObjectiveGit relies upon, using Homebrew. If you not want to use Homebrew, you will need to ensure these dependent libraries and their headers are installed where the build scripts [expect them to be](https://github.com/libgit2/objective-git/blob/master/script/bootstrap#L80-L99).
35
+
Simply run the [`script/bootstrap`](script/bootstrap) script to automatically install
36
+
dependencies needed to start building the framework. This script uses
37
+
[Homebrew](http://brew.sh) to install these tools. If your Mac does not have
38
+
Homebrew, you will need to install the following manually:
0 commit comments