summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* README: add maint/v0.26 branch statusethomson/badgificationEdward Thomson2018-09-221-0/+1
|
* README: more CI status badgesEdward Thomson2018-09-221-2/+5
|
* README: rename "VSTS" to "Azure DevOps"ethomson/ci-renameEdward Thomson2018-09-181-2/+2
| | | | | Visual Studio Team Services is now a family of applications named "Azure DevOps". Update the README to refer to it thusly.
* README: update the build badge to Azure PipelinesEdward Thomson2018-09-181-1/+1
| | | | | VSTS is now a family of components; "Azure Pipelines" is the build and release pipeline application.
* README: remove travisethomson/travisEdward Thomson2018-09-031-1/+0
|
* readme: remove appveyor build badgeEdward Thomson2018-08-091-1/+0
|
* ci: add VSTS build badge to READMEethomson/vsts-build-badgeEdward Thomson2018-08-021-0/+1
|
* README.md: detail how to list all build optionsPatrick Steinhardt2018-05-301-0/+9
| | | | | | | 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.
* README.md: fix link to `test_index_racy__diff`Patrick Steinhardt2018-05-301-1/+1
| | | | | The syntax for links is `[description](link)z, not the other way round. Fix this.
* docs: reorganize documentsPatrick Steinhardt2018-05-301-7/+7
| | | | | | | | | | 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.
* README.md: add table of contentsPatrick Steinhardt2018-05-301-0/+21
| | | | | | | 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.
* README.md: add notes on how to report security issuesPatrick Steinhardt2018-01-291-0/+6
|
* README: add up some marketingEdward Thomson2017-11-241-2/+14
|
* README: document test outputEdward Thomson2017-11-241-0/+10
|
* README: clarify why one would run libgit2_clarEdward Thomson2017-11-241-0/+23
| | | | | | 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.
* README: provide quick start paragraphEdward Thomson2017-11-241-0/+24
| | | | | Provide a very simple quick start paragraph that highlights how easy it is to get started, and points people toward common problems.
* README: drop VS command shell instructionsEdward Thomson2017-11-241-10/+0
| | | | | Users should not be advised to use the VS command prompt; instead, they should let cmake find their Visual Studio installation.
* README: suggest `ctest -V` for getting startedEdward Thomson2017-11-241-1/+1
| | | | | | | | | | 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.
* README: Mention Guile-Git bindings.Mathieu Othacehe2017-09-091-0/+2
|
* Update README: VS -> VSTSethomson/vs_to_vstsEdward Thomson2017-05-111-4/+3
| | | | | libgit2 is no longer used in Visual Studio Team Services, it's used in Visual Studio Team Services.
* README: document our relation to changes in upstreamPatrick Steinhardt2017-04-111-0/+10
| | | | | | 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.
* README: Mention how to run testsRichard Ipsum2017-03-051-0/+8
|
* Merge pull request #4037 from libgit2/cmn/goalsCarlos Martín Nieto2016-12-201-3/+11
|\ | | | | README: be more explicit in the goals and scope
| * README: be more explicit in the goals and scopecmn/goalsCarlos Martín Nieto2016-12-191-3/+11
| | | | | | | | | | Make it clearer from the get-go that we do not aim to implement user-facing commands from the git tool.
* | Gift deprecated in favor of SwiftGit2Lucas Derraugh2016-12-191-1/+1
|/
* README: adjust URL to libqgit2 repositoryPatrick Steinhardt2016-08-291-1/+1
|
* README: update "Getting Help" sectionEdward Thomson2016-06-201-11/+23
|
* README: update bindingsEdward Thomson2016-06-201-2/+1
| | | | Drop node-gitteh. Replace outdated PowerShell bindings with PSGit.
* README: improve contributing paragraphEdward Thomson2016-06-201-3/+9
|
* README: disambiguate what to distribute source ofEdward Thomson2016-06-201-2/+2
| | | | | Indicate that if you make changes to libgit2 that you must distribute the source _to libgit2_, not the source _of your program_.
* CONVENTIONS: update to include general public API principlescmn/conventionsCarlos Martín Nieto2016-02-251-0/+6
|
* Merge pull request #3552 from ReadmeCritic/masterEdward Thomson2015-12-261-7/+7
|\ | | | | Update README URLs based on HTTP redirects
| * Update libgit2-glib linkReadmeCritic2015-12-261-1/+1
| |
| * Update README URLs based on HTTP redirectsReadmeCritic2015-12-171-7/+7
| |
* | Fixed minor typo in README.md.drusk2015-12-231-1/+1
|/
* Increase required version of cmake to 2.8Tony Kelman2015-07-101-1/+1
|
* Changed README to use new OCaml bindings to gitEdgar Aroutiounian2015-05-281-1/+1
|
* Updated dlibgit link.Morton Fox2015-05-141-1/+1
|
* Android build doesn't need deps/regexYong Li2015-05-041-1/+1
| | | | | | | | | | 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.
* README: provide some more explanation about TLSEdward Thomson2015-02-231-1/+4
|
* README.md: Add Swift bindings "Gift"Brian Gesiak2015-02-041-0/+2
|
* README: Point to libgit2 account's AppVeyor badgeEdward Thomson2015-01-161-1/+1
| | | | | Microsoft is sponsoring a Pro account at AppVeyor for the libgit2 and LibGit2Sharp projects. Point to that account's badge.
* Use svg instead of png to get better image qualityPeter Dave Hello2015-01-141-1/+1
|
* Mention the init function in the READMEcmn/init-readmeCarlos Martín Nieto2014-12-141-0/+13
| | | | This fixes #2731.
* readme: Add AppVeyor build status badge/linknulltoken2014-12-101-0/+1
|
* readme: Make Travis build status badge reflect the state of masternulltoken2014-12-101-1/+1
|
* readme: Trim trailing linesnulltoken2014-12-101-2/+2
|
* docs: explicitly document the threading caveatscmn/threadingCarlos Martín Nieto2014-11-011-0/+5
| | | | | | 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.
* Flip THREADSAFE's default to ONcmn/threadsafe-onCarlos Martín Nieto2014-10-271-1/+1
| | | | | | 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.
* Fix README.mdSeijiIto2014-10-061-1/+1
|