Added brief overview

This commit is contained in:
_ 2018-04-22 17:59:52 -07:00
parent 23405ca83e
commit d6ef6e3dc5

23
docs/doc-overview.txt Normal file
View File

@ -0,0 +1,23 @@
lib3ddevil1
A C library for handling Devil May Cry 1 HD Collection PC file formats.
These formats are little endian.
Design/Restrictions
Library functions do not:
- allocate memory on the heap
- operate on files
- convert endianness
Pseudo-Namespaces
Library functions are callable through a struct of function pointers.
For example:
// Print header of a .pld file.
DEVIL1PLD.printheader(...);
// Print header of a texture pack.
DEVIL1TEX.printheader(...);
// Print header of a mesh pack.
DEVIL1GEO.printheader(...);