Commit 09365372a5a2b00994f7e42b7a610bd6fa6a788d
1 parent
19f54d98
Add table of content to README-maintainer.md
Showing
1 changed file
with
23 additions
and
1 deletions
README-maintainer.md
| 1 | +# Maintainer Notes | ||
| 2 | + | ||
| 3 | +## Contents | ||
| 4 | + | ||
| 5 | +* [ROUTINE DEVELOPMENT](#routine-development) | ||
| 6 | +* [VERSIONS](#versions) | ||
| 7 | +* [CHECKING DOCS ON readthedocs](#checking-docs-on-readthedocs) | ||
| 8 | +* [GOOGLE OSS-FUZZ](#google-oss-fuzz) | ||
| 9 | +* [CODING RULES](#coding-rules) | ||
| 10 | +* [HOW TO ADD A COMMAND-LINE ARGUMENT](#how-to-add-a-command-line-argument) | ||
| 11 | +* [RELEASE PREPARATION](#release-preparation) | ||
| 12 | +* [CREATING A RELEASE](#creating-a-release) | ||
| 13 | +* [RUNNING pikepdf's TEST SUITE](#running-pikepdfs-test-suite) | ||
| 14 | +* [OTHER NOTES](#other-notes) | ||
| 15 | +* [DEPRECATION](#deprecation) | ||
| 16 | +* [LOCAL WINDOWS TESTING PROCEDURE](#local-windows-testing-procedure) | ||
| 17 | +* [DOCS ON readthedocs.org](#docs-on-readthedocsorg) | ||
| 18 | +* [CMAKE notes](#cmake-notes) | ||
| 19 | +* [ABI checks](#abi-checks) | ||
| 20 | +* [CODE FORMATTING](#code-formatting) | ||
| 21 | + | ||
| 22 | + | ||
| 1 | ## ROUTINE DEVELOPMENT | 23 | ## ROUTINE DEVELOPMENT |
| 2 | 24 | ||
| 3 | **Remember to check pull requests as well as issues in github.** | 25 | **Remember to check pull requests as well as issues in github.** |
| @@ -631,7 +653,7 @@ This is what I do for routine testing on Windows. | @@ -631,7 +653,7 @@ This is what I do for routine testing on Windows. | ||
| 631 | 653 | ||
| 632 | * Test with mingw: `ctest --verbose -C RelWithDebInfo` | 654 | * Test with mingw: `ctest --verbose -C RelWithDebInfo` |
| 633 | 655 | ||
| 634 | -### DOCS ON readthedocs.org | 656 | +## DOCS ON readthedocs.org |
| 635 | 657 | ||
| 636 | * Registered for an account at readthedocs.org with my github account | 658 | * Registered for an account at readthedocs.org with my github account |
| 637 | * Project page: https://readthedocs.org/projects/qpdf/ | 659 | * Project page: https://readthedocs.org/projects/qpdf/ |