diff options
| author | Dr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> | 2019-11-28 23:10:51 +0100 |
|---|---|---|
| committer | Dr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> | 2020-02-26 21:04:38 +0100 |
| commit | 5f8e6c50bd862d6bb0bbd16b4c0b3be841d9cf32 (patch) | |
| tree | 41e6e7047573f760fcdf195560ccf57d672aea7f /ACKNOWLEDGEMENTS.md | |
| parent | doc: convert standard project docs to markdown (diff) | |
| download | openssl-5f8e6c50bd862d6bb0bbd16b4c0b3be841d9cf32.tar.xz openssl-5f8e6c50bd862d6bb0bbd16b4c0b3be841d9cf32.zip | |
doc: introduce some minimalistic markdown without essential changes
The goal is to transform the standard documents
README, INSTALL, SUPPORT, CONTRIBUTING, ...
from a pure text format into markdown format, but in such a way
that the documentation remains nicely formatted an easy readable
when viewed with an normal text editor.
To achieve this goal, we use a special form of 'minimalistic' markdown
which interferes as little as possible with the reading flow.
* avoid [ATX headings][] and use [setext headings][] instead
(works for `<h1>` and `<h2>` headings only).
* avoid [inline links][] and use [reference links][] instead.
* avoid [fenced code blocks][], use [indented-code-blocks][] instead.
The transformation will take place in several steps. This commit
introduces mostly changes the formatting and does not chang the
content significantly.
[ATX headings]: https://github.github.com/gfm/#atx-headings
[setext headings]: https://github.github.com/gfm/#setext-headings
[inline links]: https://github.github.com/gfm/#inline-link
[reference links]: https://github.github.com/gfm/#reference-link
[fenced code blocks]: https://github.github.com/gfm/#fenced-code-blocks
[indented code blocks]: https://github.github.com/gfm/#indented-code-blocks
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10545)
Diffstat (limited to 'ACKNOWLEDGEMENTS.md')
| -rw-r--r-- | ACKNOWLEDGEMENTS.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md index d21dccbb79..baf7743c8e 100644 --- a/ACKNOWLEDGEMENTS.md +++ b/ACKNOWLEDGEMENTS.md @@ -1,2 +1,8 @@ -Please https://www.openssl.org/community/thanks.html for the current -acknowledgements. +Acknowlegements +=============== + +Please see our [Thanks!][] page for the current acknowledgements. + + +[Thanks!]: https://www.openssl.org/community/thanks.html + |