documentation moved to doc/
authorPrzemyslaw Skibinski <inikep@gmail.com>
Thu, 3 Nov 2016 12:25:20 +0000 (13:25 +0100)
committerPrzemyslaw Skibinski <inikep@gmail.com>
Thu, 3 Nov 2016 12:25:20 +0000 (13:25 +0100)
README.md
doc/lz4_Block_format.md [moved from lz4_Block_format.md with 100% similarity]
doc/lz4_Frame_format.md [moved from lz4_Frame_format.md with 100% similarity]
lib/README.md
lib/lz4.h

index 753f11d..3f9cba6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -89,6 +89,6 @@ A list of known source ports is maintained on the [LZ4 Homepage].
 
 [Open-Source Benchmark program by m^2 (v0.14.3)]: http://encode.ru/threads/1371-Filesystem-benchmark?p=34029&viewfull=1#post34029
 [Silesia Corpus]: http://sun.aei.polsl.pl/~sdeor/index.php?page=silesia
-[lz4_Block_format]: lz4_Block_format.md
-[lz4_Frame_format]: lz4_Frame_format.md
+[lz4_Block_format]: doc/lz4_Block_format.md
+[lz4_Frame_format]: doc/lz4_Frame_format.md
 [LZ4 Homepage]: http://www.lz4.org
similarity index 100%
rename from lz4_Block_format.md
rename to doc/lz4_Block_format.md
similarity index 100%
rename from lz4_Frame_format.md
rename to doc/lz4_Frame_format.md
index f932d42..209cac1 100644 (file)
@@ -37,4 +37,4 @@ Other files present in the directory are not source code. There are :
  - liblz4.pc.in : for pkg-config (make install)
  - README.md : this file
 
-[official interoperable frame format]: ../lz4_Frame_format.md
+[official interoperable frame format]: ../doc/lz4_Frame_format.md
index 3ece4dd..0f17c7c 100644 (file)
--- a/lib/lz4.h
+++ b/lib/lz4.h
@@ -44,7 +44,7 @@ extern "C" {
  * Block compression functions are not-enough to send information,
  * since it's still necessary to provide metadata (such as compressed size),
  * and each application can do it in whichever way it wants.
- * For interoperability, there is LZ4 frame specification (lz4_Frame_format.md).
+ * For interoperability, there is LZ4 frame specification (doc/lz4_Frame_format.md).
  * A library is provided to take care of it, see lz4frame.h.
 */