summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-12-04 06:14:14 -0500
committerAmlal El Mahrouss <amlal@nekernel.org>2025-12-04 06:14:14 -0500
commite85b8a1cf1624a9cbf3d719dd202ad57d43c2f4b (patch)
tree89f7c1d07eed253f97141102041d70b12dfcd48e /README.md
parentd43fed8fb9eb369adc70a57bc2a9552d36485241 (diff)
chore: modularize OCL to OCL.core, upcoming OCL.fix
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 3 insertions, 21 deletions
diff --git a/README.md b/README.md
index 203390e..e0aadcd 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,8 @@
-# Open C++ Library
+# OCL.Core
[![License: BSL](https://img.shields.io/badge/license-BSL-blue.svg)](LICENSE)
-A set of containers in C++ for developers.<br/>
-You use them to speed up your development cycle for C++ applications.
+Core set of containers from the OCL.
## Requirements:
@@ -14,21 +13,4 @@ The OCL requires the following:
- [CMake](https://cmake.org/)
- [Git](https://git-scm.com/)
-### Example: The Option container
-
-Evaluates whether an expression is passing the options.
-
-```cpp
-#include <logic/option.hpp>
-
-int main(int argc, char** argv)
-{
- auto opt = ocl::option(ocl::eval_eq(50, 50)).expect("ocl::eval_eq, does not match!");
- opt = ocl::option(ocl::eval_eq(50, 40));
- opt.expect("this time it doesn't.");
-
- return EXIT_SUCCESS;
-}
-```
-
-##### (c) 2025 Amlal El Mahrouss, licensed under the Boost Software License.
+##### (c) 2025 Amlal El Mahrouss and OCL Authors, licensed under the Boost Software License.