joeylib2/docs/Manual.adoc
2026-09-26 21:02:41 -05:00

61 lines
1.1 KiB
Text

= JoeyLib Manual
Scott Duensing <scott.duensing@gmail.com>
:revnumber: 1.0
:revdate: 2026
:doctype: book
:title-logo-image: image:../assets/joeylibLogo.svg[JoeyLib, pdfwidth=4.5in, align=center]
:toc: left
:toclevels: 3
:sectnums:
:sectnumlevels: 3
:source-highlighter: rouge
:icons: font
:experimental:
:xrefstyle: short
// One book: the guide chapters first, then the API reference, then the
// appendices. Every chapter is its own .adoc in docs/ so a chapter can be
// edited without touching the rest. Build with scripts/build-docs.sh, or
// `make docs`, which writes build/docs/JoeyLib-Manual.html and .pdf.
= Guide
include::Overview.adoc[]
include::GettingStarted.adoc[]
include::ProgramLayout.adoc[]
include::Portability.adoc[]
include::Assets.adoc[]
include::BuildIntegration.adoc[]
= API Reference
include::ApiCore.adoc[]
include::ApiSurface.adoc[]
include::ApiPalette.adoc[]
include::ApiDraw.adoc[]
include::ApiTile.adoc[]
include::ApiSprite.adoc[]
include::ApiInput.adoc[]
include::ApiAudio.adoc[]
include::ApiFile.adoc[]
include::ApiSerial.adoc[]
include::ApiDebug.adoc[]
= Appendices
include::Appendix.adoc[]