Index: README.md ================================================================== --- README.md +++ README.md @@ -28,10 +28,11 @@ * [Nintendo DS](#nintendo-ds) * [Nintendo 3DS](#nintendo-3ds) * [Wii](#wii) * [Amiga](#amiga) * [Writing your first application with ObjFW](#first-app) + * [Documentation](#documentation) * [Bugs and feature requests](#bugs) * [Support and community](#support) * [Commercial use](#commercial-use) @@ -317,10 +318,23 @@ `objfw-compile` is a tool that allows building applications and libraries using ObjFW without needing a full-blown build system. If you want to use your own build system, you can get the necessary flags from `objfw-config`. + +

Documentation

+ + You can find the documentation for released versions of ObjFW + [here](https://objfw.nil.im/docs/). + + In order to build the documentation yourself (necessary to have documentation + for trunk / master), you need to have [Doxygen](https://www.doxygen.nl) + installed. Once installed, you can build the documentation from the root + directory of the repository: + + $ doxygen >/dev/null +

Bugs and feature requests

If you find any bugs or have feature requests, please [file a new bug](https://objfw.nil.im/tktnew) in the