Skip to content

Commit 6bc1bcf

Browse files
Update README.md
1 parent a482453 commit 6bc1bcf

File tree

1 file changed

+77
-2
lines changed

1 file changed

+77
-2
lines changed

README.md

Lines changed: 77 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,77 @@
1-
# fossil-cryptic
2-
Fossil Logic cryptography library
1+
# **Fossil Cryptic by Fossil Logic**
2+
3+
**Fossil Cryptic** is a lightweight, portable cryptography library written in pure C with zero external dependencies. Designed for maximum portability and security, Fossil Cryptic provides a suite of cryptographic primitives, hash functions, and secure utilities suitable for embedded, trust-critical, and cross-platform applications. Its minimal footprint and audit-friendly codebase make it ideal for developers needing reliable, verifiable cryptography in constrained or security-sensitive environments.
4+
5+
### Key Features
6+
7+
- **Cross-Platform Support**
8+
Runs seamlessly on Windows, macOS, Linux, and embedded systems without modification.
9+
10+
- **Zero External Dependencies**
11+
Written entirely in clean, portable C to maximize auditability and ease of integration.
12+
13+
- **Robust Cryptographic Primitives**
14+
Includes secure hash algorithms, keyed hashes, encryption helpers, and authentication mechanisms.
15+
16+
- **Lightweight and Efficient**
17+
Optimized for minimal resource usage, making it ideal for embedded and low-power devices.
18+
19+
- **Self-Contained & Auditable**
20+
All cryptographic operations are fully transparent and easy to review for correctness and security.
21+
22+
- **Modular Design**
23+
Easily extendable and customizable to fit your project’s specific cryptographic requirements.
24+
25+
## Getting Started
26+
27+
### Prerequisites
28+
29+
- **Meson Build System**
30+
Fossil Cryptic uses Meson for build configuration. If you don’t have Meson installed, please follow the installation instructions on the official [Meson website](https://mesonbuild.com/Getting-meson.html).
31+
32+
### Adding Fossil Cryptic as a Dependency
33+
34+
#### Using Meson
35+
36+
1. **Install or Upgrade Meson** (version 1.3 or newer recommended):
37+
38+
```sh
39+
python -m pip install meson # Install Meson
40+
python -m pip install --upgrade meson # Upgrade Meson
41+
```
42+
2. Add the .wrap File
43+
Place a file named fossil-cryptic.wrap in your subprojects directory with the following content:
44+
45+
```ini
46+
# ======================
47+
# Git Wrap package definition
48+
# ======================
49+
[wrap-git]
50+
url = https://github.com/fossillogic/fossil-cryptic.git
51+
revision = v0.1.0
52+
53+
[provide]
54+
fossil-cryptic = fossil_cryptic_dep
55+
```
56+
57+
3. Integrate in Your meson.build
58+
Add the dependency by including this line:
59+
60+
```meson
61+
cryptic_dep = dependency('fossil-cryptic')
62+
```
63+
64+
65+
## Build Configuration Options
66+
67+
Customize your build with the following Meson options:
68+
• Enable Tests
69+
To run the built-in test suite, configure Meson with:
70+
71+
```sh
72+
meson setup builddir -Dwith_test=enabled
73+
```
74+
75+
## Contributing and Support
76+
77+
We welcome contributions, bug reports, and feature requests! Please open issues or pull requests on the Fossil Cryptic GitHub repository or visit Fossil Logic Docs for additional information.

0 commit comments

Comments
 (0)