neru/seallib
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: wording, table of contents, and misc changes

Browse Source
This commit is contained in:
neru
2026-05-11 08:37:30 -03:00
parent b17f84cb40
commit e48076a452
1 changed files with 15 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15 -8
View File
@@ -1,11 +1,21 @@
<h1 align="center"> <h1 align="center">
<b>seallib</b> <b>🦭seallib🦭</b>
</h1> </h1>
<p align="center"> <p align="center">
A modular and tiny C++20 powered library collection of random stuff I've needed for other projects. A <b>modular and tiny C++20</b> powered library collection of random stuff I've needed for other projects.
</p> </p>
## Table of Contents
* [Installation & Integration](#installation--integration)
* [Build Options](#build-options)
* [Modules](#-modules)
* [Logging](#1-logging)
* [Assert](#2-assert)
* [Events](#3-events)
* [VFS](#4-vfs)
* [Running tests](#-running-tests)
## Installation & Integration ## Installation & Integration
### 1. Requirements ### 1. Requirements
@@ -49,6 +59,7 @@ target_link_libraries(your_project PRIVATE seallib)
--- ---
## Build Options ## Build Options
Toggle features by setting these variables to ``ON`` or ``OFF`` in your CMake configuration.
| Option | Description | Default | | Option | Description | Default |
| :--- | :--- | :--- | | :--- | :--- | :--- |
| SEALLIB_ASSERT | Enable Assertion utility | OFF | | SEALLIB_ASSERT | Enable Assertion utility | OFF |
@@ -59,9 +70,8 @@ target_link_libraries(your_project PRIVATE seallib)
--- ---
## Module Instructions ## Modules
<a name="module-logging"></a>
### 1. Logging ### 1. Logging
The Log module uses a Sink architecture. You create a Logger, attach an ILogSink, and log messages using std::format syntax. The Log module uses a Sink architecture. You create a Logger, attach an ILogSink, and log messages using std::format syntax.
@@ -91,11 +101,9 @@ int main() {
} }
``` ```
<a name="module-assertion"></a>
### 2. Assert ### 2. Assert
(Documentation pending implementation) (Documentation pending implementation)
<a name="module-events"></a>
### 3. Events ### 3. Events
The Events module provides a thread and type safe signal/slot mechanism. It allows you to define custom events with any number of parameters and subscribe to them using callbacks. The Events module provides a thread and type safe signal/slot mechanism. It allows you to define custom events with any number of parameters and subscribe to them using callbacks.
#### Basic Usage #### Basic Usage
@@ -131,7 +139,6 @@ int main() {
} }
``` ```
<a name="module-vfs"></a>
### 4. VFS ### 4. VFS
The VFS (Virtual File System) module provides a unified interface for file operations by mapping virtual paths to user defined providers. The VFS (Virtual File System) module provides a unified interface for file operations by mapping virtual paths to user defined providers.
@@ -214,7 +221,7 @@ int main() {
--- ---
## Running Tests ## Running tests
### Windows (PowerShell + Visual Studio) ### Windows (PowerShell + Visual Studio)
A script is provided to automate generation and open the solution in Visual Studio: A script is provided to automate generation and open the solution in Visual Studio: