git2wrap

C++20 wrapper for libgit2
git clone git://git.dimitrijedobrota.com/git2wrap.git
Log | Files | Refs | README | LICENSE | HACKING | CONTRIBUTING | CODE_OF_CONDUCT | BUILDING
commit 5baa1da984c3bd56061c0d96bf5da02c83ba752a
parent 1d56b1f5603b6819fc57a7b15a0db3041a3313f0
author Dimitrije Dobrota < mail@dimitrijedobrota.com >
date Sun, 26 Jan 2025 21:08:56 +0100

Add README.md

Diffstat:
M README.md | +++++++++++++++++++++++++++++++++++++++++++++ ----------

1 files changed, 45 insertions(+), 10 deletions(-)

diff --git a/ README.md b/ README.md

@@ -1,19 +1,54 @@

# git2wrap

This is the git2wrap project.
C++ 20 wrapper for libgit2

# Building and installing
## Description

See the [BUILDING](BUILDING.md) document.
This project is a C++ wrapper of famous libgit2 library.

# Contributing
I plan to add features as they are needed for my other projects, so It's still
a long way until full coverage.


## Dependencies

* CMake 3.14 or latter
* Compiler with C++20 support (tested: clang 18.1.8, gcc 14.2.1)


## Building and installing

See the [`BUILDING`](BUILDING.md) document.


## Usage

> Please reference [startgit](https://github.com/DimitrijeDobrota/startgit) for relevant usage example


## Version History

- 0.2
* Working with repository, branches, commits and diffs
* Implement exception mechanism around error codes
- 0.1
* Initial development phase
* Heavy exploration


## Contributing

See the [`CONTRIBUTING`](CONTRIBUTING.md) document.

See the [CONTRIBUTING](CONTRIBUTING.md) document.

# Licensing

<!--
Please go to https://choosealicense.com/licenses/ and choose a license that
fits your needs. The recommended license for a project of this type is the
Boost Software License 1.0.
-->
This project is licensed under the MIT License
- see the [`LICENSE`](LICENSE.md) document for details


## Acknowledgments

Inspiration, code snippets, etc.
* [`cppgit2`](https://github.com/p-ranav/cppgit2)
* [`libgit2cpp`](https://github.com/AndreyG/libgit2cpp)