README.md


Log

Author Commit Date CI Message
A-Ovchinnikov-mx 4ad36338 2020-05-11T19:10:11 Update README.md Add instructions for building libgit2 in MinGW environment
Patrick Steinhardt 7a6c4122 2020-04-01T16:15:38 README.md: update build matrix to reflect our latest releases
Patrick Steinhardt 87fc539f 2020-03-13T22:08:19 cmake: use install directories provided via GNUInstallDirs We currently hand-code logic to configure where to install our artifacts via the `LIB_INSTALL_DIR`, `INCLUDE_INSTALL_DIR` and `BIN_INSTALL_DIR` variables. This is reinventing the wheel, as CMake already provide a way to do that via `CMAKE_INSTALL_<DIR>` paths, e.g. `CMAKE_INSTALL_LIB`. This requires users of libgit2 to know about the discrepancy and will require special hacks for any build systems that handle these variables in an automated way. One such example is Gentoo Linux, which sets up these paths in both the cmake and cmake-utils eclass. So let's stop doing that: the GNUInstallDirs module handles it in a better way for us, especially so as the actual values are dependent on CMAKE_INSTALL_PREFIX. This commit removes our own set of variables and instead refers users to use the standard ones. As a second benefit, this commit also fixes our pkgconfig generation to use the GNUInstallDirs module. We had a bug there where we ignored the CMAKE_INSTALL_PREFIX when configuring the libdir and includedir keys, so if libdir was set to "lib64", then libdir would be an invalid path. With GNUInstallDirs, we can now use `CMAKE_INSTALL_FULL_LIBDIR`, which handles the prefix for us.
Peter Salomonsen d91c6eda 2020-02-23T18:26:47 README: add language binding link to wasm-git
Patrick Steinhardt add54e6c 2020-02-19T11:31:01 README: update our build matrix to reflect current releases As noted in docs/release.md, we only provide security updates for the latest two releases. Let's thus drop the build status of both v0.27 and v0.26 branches, adding the new v0.99 branch instead.
ayush-1506 103a76b4 2020-01-30T17:58:43 Update link to Julia libgit2
Drew DeVault e24b8852 2019-09-15T17:01:35 Update chat resources in README.md
Eric Huss 84262643 2019-06-20T10:32:09 Fix broken link in README
Patrick Steinhardt 62bbec5a 2019-05-24T11:09:51 SECURITY.md: split out security-relevant bits from readme GitHub has recently introduced a new set of tools that aims to ease the process around vulnerability reports and security fixes. Part of those tools is a new security tab for projects that will display contents from a new SECURITY.md file. Move relevant parts from README.md to this new file to make use of this feature.
Dominik Ritter 1fd0903a 2019-03-05T18:47:45 Update URL to git2-rs
Edward Thomson 6f778351 2019-02-13T11:15:12 README: use correct badge for nightlies The URL was incorrect for the nightly badge image; it was erroneously showing the master branch continuous integration build badge.
Edward Thomson f34faaa8 2019-02-12T16:45:57 README: include build badge for v0.28 builds Include a build badge for `maint/v0.28` builds.
Edward Thomson 52a97eed 2019-01-28T12:16:50 ci: add coverity badge to the README
Edward Thomson a74dd39b 2019-01-09T12:33:47 Use cdecl calling conventions on Win32 The recommendation from engineers within Microsoft is that libraries should have a calling convention specified in the public API, and that calling convention should be cdecl unless there are strong reasons to use a different calling convention. We previously offered end-users the choice between cdecl and stdcall calling conventions. We did this for presumed wider compatibility: most Windows applications will use cdecl, but C# and PInvoke default to stdcall for WINAPI compatibility. (On Windows, the standard library functions are are stdcall so PInvoke also defaults to stdcall.) However, C# and PInvoke can easily call cdecl APIs by specifying an annotation. Thus, we will explicitly declare ourselves cdecl and remove the option to build as stdcall.
Edward Thomson 3176d9b4 2018-09-22T19:58:37 README: add maint/v0.26 branch status
Edward Thomson 4b9a0880 2018-09-06T15:02:28 README: more CI status badges
Edward Thomson e2613039 2018-09-18T13:52:08 README: rename "VSTS" to "Azure DevOps" Visual Studio Team Services is now a family of applications named "Azure DevOps". Update the README to refer to it thusly.
Edward Thomson 464305b7 2018-09-18T13:51:25 README: update the build badge to Azure Pipelines VSTS is now a family of components; "Azure Pipelines" is the build and release pipeline application.
Edward Thomson 76cfeb20 2018-09-03T19:27:30 README: remove travis
Edward Thomson 658b8e8a 2018-08-09T09:39:39 readme: remove appveyor build badge
Edward Thomson a1ae41b8 2018-08-02T14:57:54 ci: add VSTS build badge to README
Patrick Steinhardt 432dfda0 2018-03-22T09:32:28 README.md: detail how to list all build options We do not list all build options inside of the README.md, and we definitly shouldn't do so. But in order to help people discover what can be configured, add instructions on how to have CMake generate the list of all knobs together with their current value.
Patrick Steinhardt faf2629a 2018-03-22T09:27:18 README.md: fix link to `test_index_racy__diff` The syntax for links is `[description](link)z, not the other way round. Fix this.
Patrick Steinhardt 68a3c0b1 2018-03-22T09:20:43 docs: reorganize documents Our non-technical documents are currently floating around loosely in our project's root, making it harden than necessary to discover what one is searching for. We do have a "docs/" directory, though, which serves exactly that purpose of hosting documentation. Move our non-technical documentation into the "docs/" directory. Adjust all links to these documents.
Patrick Steinhardt 8f96cf9a 2018-03-22T09:13:18 README.md: add table of contents By now, our README has grown quite long, and at multiple occassions people were unable to find the correct spot in our documentation. Add a table of contents to at least present an overview over all topics that are being covered by our README.
Patrick Steinhardt 699a48f8 2018-01-29T07:41:54 README.md: add notes on how to report security issues
Edward Thomson 5bcaba5d 2017-11-15T22:52:23 README: add up some marketing
Edward Thomson 8cbfa183 2017-11-15T22:42:35 README: document test output
Edward Thomson c5d8682f 2017-11-12T14:47:11 README: clarify why one would run libgit2_clar Since we recommend `ctest -V`, it's not clear why somebody would want to run `libgit2_clar`. Indicate that it's helpful when running individual tests or suites.
Edward Thomson 9e91a989 2017-11-12T13:05:59 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.
Edward Thomson dc985353 2017-11-12T12:03:21 README: drop VS command shell instructions Users should not be advised to use the VS command prompt; instead, they should let cmake find their Visual Studio installation.
Edward Thomson b2d54cfa 2017-11-12T11:59:56 README: suggest `ctest -V` for getting started Suggest that users run `ctest -V` instead of `make test` when getting started. `ctest -V` is superior over alternatives as: 1. Unlike `make test`, it gives output. Users getting started with the library believe that it is hung. 2. `ctest -V` shows verbose output; showing suite names is helpful for giving users more feedback immediately.
Mathieu Othacehe b4e0d293 2017-09-09T09:54:58 README: Mention Guile-Git bindings.
Edward Thomson 1e27b89f 2017-05-11T13:56:55 Update README: VS -> VSTS libgit2 is no longer used in Visual Studio Team Services, it's used in Visual Studio Team Services.
Patrick Steinhardt 19a04f67 2017-04-10T12:01:28 README: document our relation to changes in upstream libgit2 is a mere consumer of changes which are trickling down from the upstream git.git project. This commit documents the ramifications caused by this relation.
Richard Ipsum 5c06111b 2017-02-25T17:13:15 README: Mention how to run tests
Carlos Martín Nieto 329ce043 2016-12-20T12:14:22 Merge pull request #4037 from libgit2/cmn/goals README: be more explicit in the goals and scope
Lucas Derraugh 87faeaec 2016-12-19T09:09:34 Gift deprecated in favor of SwiftGit2
Carlos Martín Nieto 8f064000 2016-12-19T13:54:55 README: be more explicit in the goals and scope Make it clearer from the get-go that we do not aim to implement user-facing commands from the git tool.
Patrick Steinhardt 8044ee42 2016-08-29T09:38:20 README: adjust URL to libqgit2 repository
Edward Thomson 2976dcf8 2016-06-20T15:05:02 README: update "Getting Help" section
Edward Thomson 738ca6ee 2016-06-20T14:30:33 README: update bindings Drop node-gitteh. Replace outdated PowerShell bindings with PSGit.
Edward Thomson 0820d0c8 2016-06-20T14:24:17 README: improve contributing paragraph
Edward Thomson 69d11971 2016-06-20T14:16:50 README: disambiguate what to distribute source of Indicate that if you make changes to libgit2 that you must distribute the source _to libgit2_, not the source _of your program_.
Carlos Martín Nieto 1f8cb02f 2016-02-25T14:51:00 CONVENTIONS: update to include general public API principles
Edward Thomson a066b4cb 2015-12-26T18:31:22 Merge pull request #3552 from ReadmeCritic/master Update README URLs based on HTTP redirects
ReadmeCritic 1ce509fe 2015-12-26T15:51:32 Update libgit2-glib link
drusk 22829b74 2015-12-23T21:27:40 Fixed minor typo in README.md.
ReadmeCritic 1181ca0c 2015-12-17T08:36:04 Update README URLs based on HTTP redirects
Tony Kelman 37c84dc5 2015-07-05T10:07:48 Increase required version of cmake to 2.8
Edgar Aroutiounian 69560cc0 2015-05-28T15:19:53 Changed README to use new OCaml bindings to git
Morton Fox e702dc2e 2015-05-14T15:49:51 Updated dlibgit link.
Yong Li 57aa839c 2015-05-04T09:41:34 Android build doesn't need deps/regex deps/regex was included in Android build because Android NDK 4 has a packaging bug and doesn't have the regular expression functions defined in its libc.so. The bug has been fixed in subsequent Android NDK releases. If it is still necessary to work around the bug in Android NDK 4, we should consider to use an option like ANDROID_NDK_RELEASE or ANDROID_NDK_RELEASE_NUM.
Edward Thomson ecf1c3c3 2015-02-23T11:18:52 README: provide some more explanation about TLS
Brian Gesiak 35425b51 2015-02-04T01:06:07 README.md: Add Swift bindings "Gift"
Edward Thomson 7cfbf3b7 2015-01-15T16:56:58 README: Point to libgit2 account's AppVeyor badge Microsoft is sponsoring a Pro account at AppVeyor for the libgit2 and LibGit2Sharp projects. Point to that account's badge.
Peter Dave Hello c5c8ece1 2015-01-14T02:14:38 Use svg instead of png to get better image quality
Carlos Martín Nieto ed09e044 2014-12-14T16:18:09 Mention the init function in the README This fixes #2731.
nulltoken a7e06cb0 2014-12-10T10:11:37 readme: Add AppVeyor build status badge/link
nulltoken 037b2a8b 2014-12-10T09:55:29 readme: Make Travis build status badge reflect the state of master
nulltoken 775d831b 2014-12-10T10:03:07 readme: Trim trailing lines
Carlos Martín Nieto 15bea02c 2014-10-31T11:24:02 docs: explicitly document the threading caveats Talk about sharing objects and error messages; but the most important part is about what to do with the cryptographic libraries, which sadly have to become to responsibility of the application.
Carlos Martín Nieto 79b0ae4e 2014-10-27T10:30:57 Flip THREADSAFE's default to ON Threads are here to stay; and for a while now, users have had to call the initialization function which sets up threads and crypto regardless of whether the library was built threadsafe or not.
SeijiIto 18925129 2014-10-06T16:17:01 Fix README.md
Brendan Forster a2a23322 2014-09-30T04:16:17 the wiki, it is dead
Linquize 2c22193b 2014-09-16T08:56:33 Fix typo
Alex Crichton b4913705 2014-09-15T12:11:48 Add Rust to the language bindings list
jake bolewski d747ec18 2014-08-25T20:50:06 add Julia to the language bindings list
Jacques Germishuys 2ef20da0 2014-07-13T17:52:33 Updated perl bindings link
Stefan Widgren 562516ec 2014-05-13T22:43:59 Add R bindings to the README
Russell Belfer 486bc366 2014-02-26T16:37:08 Add project list and update readme
Russell Belfer 68a19ca9 2014-02-20T11:26:51 Clarify C compatibility policy and a couple of other minor doc fixups.
Ben Straub c85d606e 2014-01-16T11:36:06 Merge pull request #2044 from libgit2/coverity Run Coverity scan on Travis
Edward Thomson 4ef9a508 2014-01-15T13:58:11 Update README to include Java, PowerShell bindings
Ben Straub 4caf0df0 2014-01-13T15:43:29 Add coverity scan badge to readme
Andrius Bentkus 7b50c784 2013-12-27T15:15:48 docs: Remove non existing wrapper from the readme libgit2net stopped to exist, all hail libgit2sharp
Ben Straub dcfdb977 2013-11-01T10:51:12 Relicense examples under CC0
Nicolas Kaiser 63d1fad4 2013-10-24T15:30:31 fix typos in README.md
Carlos Martín Nieto 2baee9f8 2013-10-23T13:17:51 README: add a note about the optional dependencies
Haneef Mubarak caf93341 2013-10-17T16:01:43 slightly clarified the "license" portion of `README.md" + formatting all over fixed typo `can can` -> `can`
Haneef Mubarak e5e2710b 2013-10-17T01:52:20 slightly clarified the "license" portion of `README.md" + formatting all over added the second change suggested by @nulltoken (with two extra words :) )
Haneef Mubarak 20b5d300 2013-10-17T00:28:08 slightly clarified the "license" portion of `README.md" + formatting all over There are commercial open source applications, hence proprietary seems to be a better term. Also: - Trimmed header `=`'s to match text length - made libgit2 stand out everywhere - pretty printing links - irc link for those with the correct setup
Krzysztof Adamski 01cd5ae3 2013-09-01T19:43:35 Add instructions about buiding for Android to README.md
Carlos Martín Nieto f2cda906 2013-08-31T17:42:38 Point to the right Go bindings
Nirvana a402179a 2013-08-31T09:25:25 Update readme to point to the currently maintained Erlang bindings. Namely: https://github.com/carlosmn/geef
Edward Thomson bef59b1b 2013-07-19T12:56:47 Update README.md
Edward Thomson 41a93cc6 2013-07-19T12:43:08 Clarify when to use github issues Suggest that github issues are to be used for bug reports, while questions about usage should be directed to StackOverflow.
Martin Woodward 3e3d332b 2013-07-19T18:04:11 Tidy up the methods of contacting the project Updated the methods of getting involved with the project and asking questions.
Ben Straub 743048f1 2013-04-19T10:29:50 Fix some minor issues
Alessandro Ghedini 1cfaaa9e 2013-04-17T13:48:26 Update link to Perl bindings
Maxwell Swadling 7d5b0f8b 2013-04-09T09:28:40 Updated link to Haskell bindings The old one hasn't been updated in a long time. This one is current.
Carlos Scheidegger 4f1da3a2 2013-02-06T16:55:09 removed obsolete reference to api.html
Vicent Martí a8182d49 2013-01-30T12:24:38 Let people know that the ML is deprecated
Carlos Martín Nieto 66bf4dbc 2012-11-13T16:57:37 Explain a few CMake options in the README Expose STDCALL and explain a few useful CMake options, as well as explain the quirks building on Windows.
Keith Dahlby 221ee54b 2012-11-04T21:24:14 Fix Clar link
Veeti Paananen 9795a40f 2012-10-19T17:33:13 Use standard CMake variable names for installation paths Rename INSTALL_INC and INSTALL_BIN to INCLUDE_INSTALL_DIR and BIN_INSTALL_DIR, which are more commonly used. This is also consistent with the variable for the library path which is already LIB_INSTALL_DIR.
Andrej Mitrovic 26127ea7 2012-10-11T18:22:00 Add link to D libgit2 bindings.
Michael Schubert 77ace82d 2012-07-16T12:41:30 libgit2.pc.in: also switch to LIB_INSTALL_DIR b3237ac3 changed CMakeList.txt to use the more standard LIB_INSTALL_DIR variable instead of INSTALL_LIB, but forgot to change libgit2.pc.in etc. accordingly.
Ignacio Casal Quinteiro a7a2fccd 2012-07-09T13:12:16 Point to the libgit2-glib wiki page
Ignacio Casal Quinteiro 36bae3e9 2012-05-31T09:56:05 libgit2-glib bindings moved to gnome servers