Skip to content
This repository was archived by the owner on Aug 13, 2025. It is now read-only.
/ sf3 Public archive

Commit 22c7886

Browse files
committed
Readme
1 parent ff6860d commit 22c7886

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
11
# About SF3
22
SF3 is a Simple File Format Family. Please see the [specification homepage](https://shirakumo.github.io/sf3).
3+
4+
## Files in this repository
5+
- `LICENSE`
6+
The license of the specification and related files (zlib)
7+
- `specification.mess`
8+
Original source text for the specification in [Markless](https://shirakumo.org/docs/markless) format.
9+
- `samples/`
10+
Sample files to test SF3 implementations against.
11+
- `magic`
12+
libmagic/UNIX-file magic parser for SF3 files.
13+
- `card.png`, `index.html`, `template.ctml`, `style.css`, `style.lass`, `style.tex`
14+
Used for generating website and the HTML and PDF versions of the specification.
15+
16+
## Related projects
17+
- [sf3.ksy](https://shirakumo.org/projects/sf3.ksy)
18+
Implementation of the SF3 file formats in Kaitai struct, from which libraries in many languages can also be generated.
19+
- [libsf3](https://shirakumo.org/docs/libsf3)
20+
Implementation of the SF3 file formats in C99 as a header-only library.
21+
- [cl-sf3](https;//shirakumo.org/docs/cl-sf3)
22+
Implementation of the SF3 file formats in Common Lisp.

0 commit comments

Comments
 (0)