From 97d846f41e2bccf7957983c03d1fe9867b789efb Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Thu, 5 Mar 2026 15:31:57 +0100 Subject: [FEAT] New Option 2 example, updated README, fixed crc_hash.hpp. Signed-off-by: Amlal El Mahrouss --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'README.md') 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("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. -- cgit v1.2.3