1## Synopsis 2 3This utility accepts an [SQLite](https://www.sqlite.org) header file 4`sqlite.h` and produces a set of decently well-formed 5[mdoc(7)](http://man.openbsd.org/OpenBSD-current/man7/mdoc.7) files 6documenting the C API. 7These will be roughly equivalent to the [C-language Interface 8Specification for SQLite](https://www.sqlite.org/c3ref/intro.html). 9 10You can also use it for any file(s) using the documentation standards of 11SQLite. 12See the [sqlite2mdoc.1](sqlite2mdoc.1) manpage for syntax details. 13 14This [GitHub](https://www.github.com) repository is a read-only mirror 15of the project's CVS repository. 16 17## Installation 18 19Simply run `make`: this utility isn't meant for installation, but for 20integration into your SQLite deployment phase. 21You can run `make install`, however, if you plan on using it for other 22documentation. 23There are no compile-time or run-time dependencies unless you're on 24Linux, in which case you'll need 25[libbsd](https://libbsd.freedesktop.org). 26You'll also need to uncomment the `LDADD` line in the 27[Makefile](Makefile), in this case. 28 29 30This software has been used on OpenBSD, Mac OS X, and Linux machines. 31 32## License 33 34All sources use the ISC (like OpenBSD) license. 35See the [LICENSE.md](LICENSE.md) file for details. 36