summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-12-02 06:14:31 -0500
committerGitHub <noreply@github.com>2025-12-02 06:14:31 -0500
commit92d95762c9cf75d9493ec75042c9415b382f10b0 (patch)
treedfcbd5b3fb9303e40b32db34cc857243df86ffc9 /README.md
parenta28d3e2e4e99793cf91f919d9341f5e07aa998e1 (diff)
parentbea0e3e713751e5c2a4d2d4343d8215333eef03e (diff)
Merge pull request #37 from amlel-el-mahrouss/developv1
chore: module source code tweaks and improvements.
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/README.md b/README.md
index 7288ae4..203390e 100644
--- a/README.md
+++ b/README.md
@@ -2,20 +2,21 @@
[![License: BSL](https://img.shields.io/badge/license-BSL-blue.svg)](LICENSE)
-## Brief:
-
-A set of containers in C++ for developers.
+A set of containers in C++ for developers.<br/>
+You use them to speed up your development cycle for C++ applications.
## Requirements:
+The OCL requires the following:
+
- [Boost](https://www.boost.org/)
- [Clang](https://clang.llvm.org/)
- [CMake](https://cmake.org/)
- [Git](https://git-scm.com/)
-## Examples:
+### Example: The Option container
-### Logic Module (Option container)
+Evaluates whether an expression is passing the options.
```cpp
#include <logic/option.hpp>