docs: add README and CHANGELOG

This commit is contained in:
2026-09-13 17:15:52 +02:00
parent 6b82dc677c
commit 4af011233d
2 changed files with 40 additions and 2 deletions
+8
View File
@@ -0,0 +1,8 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
+32 -2
View File
@@ -1,3 +1,33 @@
# fpk
# fpk (Forlorn Pak)
Packs a directory tree into a single flat binary archive
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
Packs a directory tree into a single flat binary archive. C89, no dependencies.
## Building
```bash
./build.sh debug release tools # Unix
build.bat debug release tools # Windows
```
## Usage
```bash
fpack output.fpk assets/
funpack output.fpk [unpacked/] # dir defaults to "output" if omitted
```
```c
#include <fpk/fpk.h>
fpk_t *pak = fpk_open("assets.fpk");
fpk_find(pak, "some/file.bin", &data, &size);
fpk_close(pak);
```
See [docs/format.md](docs/format.md) for the on-disk layout.
## License
Mozilla Public License 2.0 (MPL-2.0)