lib/zstd
1
0
Fork 0
mirror of https://github.com/facebook/zstd.git synced 2025-07-30 22:23:13 +03:00
Code Activity

Update documentation link to html format

Browse Source 
fix #3319
This commit is contained in:
Yann Collet
2022-12-15 15:56:11 -08:00
parent a91e7ec175
commit 1bc9dfe46e
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/README.md
View File

@ -5,8 +5,9 @@ This directory contains material defining the Zstandard format,
as well as detailed instructions to use `zstd` library. as well as detailed instructions to use `zstd` library.
__`zstd_manual.html`__ : Documentation of `zstd.h` API, in html format. __`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) Unfortunately, Github doesn't display `html` files in parsed format, just as source code.
to display documentation of latest release in readable format within a browser. 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. __`zstd_compression_format.md`__ : This document defines the Zstandard compression format.
Compliant decoders must adhere to this document, Compliant decoders must adhere to this document,