diff options
| author | Matthias Dressel <code@deadcode.eu> | 2022-01-01 20:08:27 +0300 |
|---|---|---|
| committer | Matthias Dressel <code@deadcode.eu> | 2022-01-04 17:26:01 +0300 |
| commit | 633c63ed51b54a14c0fc547255b97f0e657e054d (patch) | |
| tree | d2a2fbc9e5f2fbc49818e8afdd3a63c290576a2f /README.md | |
| parent | 37881b82782620feb1590ce7f56473560d364212 (diff) | |
README: Add the new documentation option
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 8 insertions, 3 deletions
@@ -105,6 +105,14 @@ For 32-bit linux, run meson build --cross-file=package/crossfiles/i686-linux32.meson ``` +## Build documentation + +1. Install [doxygen](https://www.doxygen.nl/) and [graphviz](https://www.graphviz.org/) +2. Run `meson build -Denable_docs=true` to create the build directory +3. Run `ninja -C build doc/html` to build the docs + +The result can be found in `build/doc/html/`. An online version built from master can be found [here](https://videolan.videolan.me/dav1d/). + # Run tests 1. In the root directory, run `git clone https://code.videolan.org/videolan/dav1d-test-data.git tests/dav1d-test-data` to fetch the test data repository @@ -146,6 +154,3 @@ Please read the [AV1 patent license](doc/PATENTS) that applies to the AV1 specif ## Will you care about <my_arch>? <my_os>? - We do, but we don't have either the time or the knowledge. Therefore, patches and contributions welcome. - -## Where can I find documentation? -- The current library documentation, built from master, can be found [here](https://videolan.videolan.me/dav1d/). |