This repository is the home of the AppImage project's documentation. It is the central source of information for users of AppImage (both users and developers).

View it at https://docs.appimage.org/.

This is a Sphinx project, and can be built like any other Sphinx project (e.g., using make html)

For less experienced users of Sphinx/Python/virtualenv etc., a convenience script that sets up a local isolated Sphinx environment is included. It's a transparent wrapper for the Makefile, and can be used as a drop-in replacement ./make.sh html.

For development (i.e., writing documentation), sphinx-autobuild has been integrated into the build system, which sets up a live-reloading webserver that rebuilds the site on changes and reloads the page in the browser automatically. You can use it by running ./make.sh watch.