Skip to content

Commit

Permalink
doc: add readme for glassy library
Browse files Browse the repository at this point in the history
Add readme file for glassy library.
  • Loading branch information
melg8 committed Dec 10, 2024
1 parent 0f89da9 commit 2b038c2
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions sources/example_glassy/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Glassy Library

An experiment of creating small library wrapper for OpenSSL functions using modern C++ features and using externallibraries providing useful types and abstractions.

## Project Structure

```
.
├── application/ # Application code
├── library/ # Core library implementation
│ └── sources/ # Library source files
├── tests/ # Test suite
└── third_party/ # External dependencies
```

## Dependencies

- OpenSSL
- GSL (Guidelines Support Library)
- Outcome library

## Features

- Big number operations with OpenSSL integration
- ASN.1 integer handling
- Memory management helpers
- Numeric conversions utilities
- Not-null concepts implementation
- Error handling using Outcome library



## Components

### Library

The core library provides several key components:

- `BigNum`: A wrapper around OpenSSL's BIGNUM functionality
- `ASN1Integer`: ASN.1 integer implementation
- `MemoryHelpers`: Memory management utilities
- `NumericConversions`: Safe numeric conversion utilities
- `NotNullConcepts`: Implementation of not-null pointer concepts

### Tests

The project includes a comprehensive test suite to ensure reliability and correctness of the implementation.

0 comments on commit 2b038c2

Please sign in to comment.