Skip to content

Commit

Permalink
spcfile: better documentation for docs.rs
Browse files Browse the repository at this point in the history
  • Loading branch information
kleinesfilmroellchen committed Oct 2, 2024
1 parent 2b4ae46 commit 17bfe5a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions spcfile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ A library for reading and writing .spc files, used for storing SNES game audio.

This library is part of [`spcasm`](https://github.com/kleinesfilmroellchen/spcasm) and follows spcasm's release schedule and version numbers.

## Examples

Use [`parser::parse_from_bytes`] to parse an SPC file from a byte slice. It either returns a [`nom`] parsing error, or an [`SpcFile`] struct. This struct is a straightforward representation of the SPC file format structure, split into [`SpcHeader`] and [`SpcMemory`].

The `spcdump` example is a simple utility to print out the parsed result of any .spc file.

## A Word of Warning about .spc

.spc, despite being fairly simple (and not having to convey much information), is an insanely bad file format. Here are some of the issues relating to spcfile's reading behavior:
Expand Down

0 comments on commit 17bfe5a

Please sign in to comment.