basedOpinionated utility library |
git clone git://git.dimitrijedobrota.com/based.git |
Log | Files | Refs | README | LICENSE | HACKING | CONTRIBUTING | CODE_OF_CONDUCT | BUILDING |
commit | 523b08ac6fe91c3418e5613ccaee506a7c4aa781 |
parent | ba78b255924a129f568eff1250d4685d86f8f127 |
author | Dimitrije Dobrota < mail@dimitrijedobrota.com > |
date | Wed, 30 Apr 2025 09:33:10 +0200 |
Version 0.1
M | README.md | | | +++++++++++++++++++++++++++++++++++++++++ ----------- |
1 files changed, 41 insertions(+), 11 deletions(-)
diff --git a/ README.md b/ README.md
@@ -1,19 +1,49 @@
# based
This is the based project.
Opinionated utility library
# Building and installing
## Description
See the [BUILDING](BUILDING.md) document.
This project is supposed to be the base for all of my other work. All of the
thought on safety, reusability and performance, once it has reached the
maturity, and stood the test of time, will end up here to be leveraged by all
of the projects. This is also a place for experimentation so new ideas can
prove them selves in real-world scenarios.
# Contributing
This projects is still under heavy development, so I don't recommend using it
explicitly, but bits and pieces can be interesting to extract.
See the [CONTRIBUTING](CONTRIBUTING.md) document.
# Licensing
## Dependencies
* CMake 3.14 or latter
* Compiler with C++20 support (tested on gcc 14.2.1 and clang 19.1.7)
## Building and installing
See the [`BUILDING`](BUILDING.md) document.
## Usage
> Please reference example folder for relevant usage examples.
## Version History
* 0.1
* Good collection of concepts
* Algorithms that leverage compile-time safety
* Instrumentation for measuring
## Contributing
See the [`CONTRIBUTING`](CONTRIBUTING.md) document.
## License
This project is licensed under the MIT License - see the [`LICENSE`](LICENSE.md) file for details
<!--
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.
-->