summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2026-03-05 15:18:04 +0100
committerAmlal El Mahrouss <amlal@nekernel.org>2026-03-05 15:18:37 +0100
commit04548b4affdc3f4aeae3fc7698d7e01ece9b02c1 (patch)
treeda253c4296a012d18c7c181c998d3a5ecfb48855
parentfd7d880196db79f4cba69aa36438aa9213ddd918 (diff)
[CHORE] Update TProc README with an example.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9368be7..40ad55b 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,24 @@ The OCL requires the following:
- [Git](https://git-scm.com/)
- OCL.Core
+## Using TProc:
+
+Taken from the example, you can see:
+
+```cpp
+int main()
+{
+ auto rope = tproc::crope("The Quick Brown Fox Jumps Over The Lazy Dog");
+ auto new_elem = std::make_unique<tproc::crope>(", and Jumps again.");
+
+ rope.concat(new_elem.get());
+
+ std::cout << *++rope << std::endl;
+}
+```
+
+The library is header-only as well, so no compilation step is needed, and is written in modern C++ (C++17 or later).
+
## Freestanding Status
The Freestanding Status is a concept where a module is evaluated on whether it has or is fully freestanding or not.