commit b4c63f60aca7666d12e77bce83cdbcb3f216e546 from: Evan Burkey date: Wed Mar 18 19:35:55 2026 UTC Convert README from markdown to plaintext commit - 6a7777502c8bdde942bbe2a2c5c52714f15551d1 commit + b4c63f60aca7666d12e77bce83cdbcb3f216e546 blob - 88c244c0e7b1e8b69908410f6d3bb79b0b8f3663 (mode 644) blob + /dev/null --- README.md +++ /dev/null @@ -1,30 +0,0 @@ -# spitwad - -A C library for reading, writing, and manipulating WAD files. The [WAD format](https://burkey.co/Software+Documentation/spitwad/WAD+Format) was created by id Software for DOOM and has since become a staple of game modding. spitwad treats WADs as a general-purpose archive format — use it for your DOOM clone, or package arbitrary data and send it over a network. - -## Quick Start - -```bash -cmake -B build -cmake --build build -``` - -```c -#include "spitwad.h" - -struct WAD wad; -wad_init(&wad, PWAD); -wad_add_lump(&wad, "GREETING", (const unsigned char *)"hello", 5); -wad_write_file(&wad, "hello.wad"); -wad_destroy(&wad); -``` - -## Requirements - -- CMake 3.22+ -- C99 compiler -- Any POSIX platform (Linux, macOS, BSD) - -## Documentation - -Full API reference and format documentation: [burkey.co/Software Documentation/spitwad](https://burkey.co/Software+Documentation/spitwad/spitwad) blob - /dev/null blob + fa87350bd27d4ec6d96285cd1af1c1f5526500e7 (mode 644) --- /dev/null +++ README @@ -0,0 +1,26 @@ +spitwad + +A C library for reading, writing, and manipulating WAD files. The [WAD format](https://burkey.co/Software+Documentation/spitwad/WAD+Format) was created by id Software for DOOM and has since become a staple of game modding. spitwad treats WADs as a general-purpose archive format — use it for your DOOM clone, or package arbitrary data and send it over a network. + +-- Quick Start -- + +cmake -B build +cmake --build build + +#include "spitwad.h" + +struct WAD wad; +wad_init(&wad, PWAD); +wad_add_lump(&wad, "GREETING", (const unsigned char *)"hello", 5); +wad_write_file(&wad, "hello.wad"); +wad_destroy(&wad); + +-- Requirements -- + +- CMake 3.22+ +- C99 compiler +- Any POSIX platform (Linux, macOS, BSD) + +-- Documentation -- + +Full API reference and format documentation: [burkey.co/Software Documentation/spitwad](https://burkey.co/Software+Documentation/spitwad/spitwad)