Overview
| Comment: | README.md: Add documentation section |
|---|---|
| Downloads: | Tarball | ZIP archive | SQL archive |
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA3-256: |
1d627ae293d0bb208a45a1d21be618fc |
| User & Date: | js on 2020-06-01 00:17:16 |
| Other Links: | manifest | tags |
Context
|
2020-06-01
| ||
| 18:29 | README.md: Fix a weird line break check-in: eb58561473 user: js tags: trunk | |
| 17:16 | OFFileURLHandler: Add support for setting mtime check-in: 1273a3a39a user: js tags: set-mtime | |
| 00:17 | README.md: Add documentation section check-in: 1d627ae293 user: js tags: trunk | |
| 00:01 | README.md: Add a "Cloning the repository" section check-in: 4c1f7dbb1a user: js tags: trunk | |
Changes
Modified README.md from [626cbe71fc] to [95380e6631].
| ︙ | |||
26 27 28 29 30 31 32 33 34 35 36 37 38 39 | 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | + |
* [Getting, building and installing ObjFW](#steps-windows)
* [Nintendo DS, Nintendo 3DS and Wii](#nintendo)
* [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)
<h1 id="what">What is ObjFW?</h1>
|
| ︙ | |||
315 316 317 318 319 320 321 322 323 324 325 326 327 328 | 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 | + + + + + + + + + + + + + |
$ objfw-compile -o MyFirstApp MyFirstApp.m
`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`.
<h1 id="documentation">Documentation</h1>
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
<h1 id="bugs">Bugs and feature requests</h1>
If you find any bugs or have feature requests, please
[file a new bug](https://objfw.nil.im/tktnew) in the
[bug tracker](https://objfw.nil.im/reportlist).
|
| ︙ |