]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
Update documentation link to html format
authorYann Collet <cyan@fb.com>
Thu, 15 Dec 2022 23:56:11 +0000 (15:56 -0800)
committerYann Collet <cyan@fb.com>
Thu, 15 Dec 2022 23:57:29 +0000 (15:57 -0800)
fix #3319

doc/README.md

index 705adfe5b103ffadae763e273ab7eb37b504f49a..8f3babcdbb2696ae87ba68a97c23344074a67bac 100644 (file)
@@ -5,8 +5,9 @@ This directory contains material defining the Zstandard format,
 as well as detailed instructions to use `zstd` library.
 
 __`zstd_manual.html`__ : Documentation of `zstd.h` API, in html format.
-Click on this link: [https://facebook.github.io/zstd/zstd_manual.html](https://facebook.github.io/zstd/zstd_manual.html)
-to display documentation of latest release in readable format within a browser.
+Unfortunately, Github doesn't display `html` files in parsed format, just as source code.
+For a readable display of html API documentation of latest release,
+use this link: [https://raw.githack.com/facebook/zstd/release/doc/zstd_manual.html](https://raw.githack.com/facebook/zstd/release/doc/zstd_manual.html) .
 
 __`zstd_compression_format.md`__ : This document defines the Zstandard compression format.
 Compliant decoders must adhere to this document,