summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-11-21 01:32:26 +0100
committerAmlal El Mahrouss <amlal@nekernel.org>2025-11-21 01:42:01 +0100
commit682d03f0b8e22168e2ccd2c4a35efae230d40eb0 (patch)
tree10583ee7130379feef0cd440266142fb6eede906 /README.md
parent7e757c3eacb05756b0f616e4ace46c098c39a05c (diff)
feat: Using BSL now, final commit before the Cork release.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5ac9d54..fe52987 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,19 @@ A C++ library with additional modules for your C++ SDLC.
- Clang (https://clang.llvm.org/)
- Git (https://git-scm.com/)
+## Structure:
+
+- `core`: Core utilities and fundamental abstractions used across OCL.
+- `except`: Exception classes and error-handling helpers.
+- `fix`: FIX protocol utilities and helpers for Financial Information eXchange integration.
+- `io`: Input/output utilities, stream helpers, and file handling.
+- `log`: Logging facilities, macros, and helpers for diagnostics.
+- `memory`: Memory management utilities, allocators, and smart-pointer helpers.
+- `net`: Networking utilities and lightweight socket helpers.
+- `simd`: SIMD-optimized algorithms and low-level performance helpers.
+- `tests`: Unit and integration tests that validate OCL components.
+- `utility`: General-purpose helper functions and small algorithms.
+
## Examples:
### Logic Module (Option container)
@@ -29,4 +42,4 @@ int main(int argc, char** argv)
}
```
-##### (c) 2025 Amlal El Mahrouss, licensed under the MIT license.
+##### (c) 2025 Amlal El Mahrouss, licensed under the Boost Software License.