aboutsummaryrefslogtreecommitdiff
path: root/lib/README.md
diff options
context:
space:
mode:
authorBing Xu <bingxu@fb.com>2018-11-26 11:30:15 -0800
committerBing Xu <bingxu@fb.com>2018-11-26 11:30:15 -0800
commitb192c86ba43b3b762e705f4cdd509da3250e1c0c (patch)
tree94670300543846b7c4d655e92c14df055bd2b52a /lib/README.md
parentb4efd20ac84a992d7f599d693e851c821e9b6800 (diff)
downloadlz4-b192c86ba43b3b762e705f4cdd509da3250e1c0c.tar.gz
[amalgamation] lz4frame.c
Diffstat (limited to 'lib/README.md')
-rw-r--r--lib/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/README.md b/lib/README.md
index 8b3b424c..e3fdbf34 100644
--- a/lib/README.md
+++ b/lib/README.md
@@ -42,6 +42,19 @@ Should they be nonetheless needed, it's possible to force their publication
by using build macro `LZ4_PUBLISH_STATIC_FUNCTIONS`.
+#### Amalgamation
+
+lz4 code is able to be amalgamated into a single file.
+We can combine all source code in `lz4_all.c` by using following command,
+```
+cat lz4.c > lz4_all.c
+cat lz4hc.c >> lz4_all.c
+cat lz4frame.c >> lz4_all.c
+```
+and compile `lz4_all.c`.
+It's necessary to include all `*.h` files present in `/lib` together with `lz4_all.c`.
+
+
#### Windows : using MinGW+MSYS to create DLL
DLL can be created using MinGW+MSYS with the `make liblz4` command.