summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2026-03-05 15:31:57 +0100
committerAmlal El Mahrouss <amlal@nekernel.org>2026-03-05 15:31:57 +0100
commit97d846f41e2bccf7957983c03d1fe9867b789efb (patch)
tree9d2193612d3f9b3976bea40243d63e60d31fe5d9 /README.md
parentfcc9da9f2f3b5c3002349e43faad065716606751 (diff)
[FEAT] New Option 2 example, updated README, fixed crc_hash.hpp.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 938e1d5..cdad359 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,25 @@ The OCL requires:
The OCL aims to be easily installable and to get up and running.
+## Core by Examples:
+
+You can have a look at the examples in order to get familiar with the library.
+
+```cpp
+int main(int argc, char** argv)
+{
+ ocl::option opt{ocl::eval_eq(nullptr, nullptr)};
+ opt.expect("option::incorrect");
+
+ opt = ocl::option{ocl::eval_eq(argv, nullptr)};
+ opt.expect<invalid_callable>("option::incorrect");
+
+ return 0;
+}
+```
+
+This one implements an `ocl::option` container, which is used for error handling and other related tasks.
+
## Freestanding Status:
The Freestanding Status is a concept where a module is evaluated on whether it has or is fully freestanding or not.