summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNathan Moinvaziri <nathan@nathanm.com>2020-05-19 08:40:43 -0700
committerHans Kristian Rosbach <hk-github@circlestorm.org>2020-05-25 15:18:46 +0200
commit9dd427a1566a6273c4b409269a414459ccbdd2c6 (patch)
treeb87386aadfa5b5df7702363e91cbd3c67b13dc45
parent8f110451f76d3b0b4fca07b523883d03ad56f6b7 (diff)
downloadProject-Tick-9dd427a1566a6273c4b409269a414459ccbdd2c6.tar.gz
Project-Tick-9dd427a1566a6273c4b409269a414459ccbdd2c6.zip
Added features list to README.md.
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index e6c3a6be78..a1b68977ed 100644
--- a/README.md
+++ b/README.md
@@ -51,6 +51,29 @@ or valuable testing.
Please read LICENSE.md, it is very simple and very liberal.
+Features
+--------
+
+* Zlib compatible API with support for dual-linking
+* Modernized native API based on zlib API for ease of porting
+* Intel deflate medium and quick algorithms
+* Support for CPU intrinsics when available
+ * Adler32 implementation using ARM Neon
+ * Intel CRC32-B implementation using PCLMULQDQ
+ * Intel CRC32-C intrinics for hash tables
+ * ARM CRC32-B implementation using ACLE
+ * Slide hash implementations using AVX2, SSE2, & ARM Neon
+ * Inflate fast using SSE2, ARM Neon
+ * Deflate hooks for IBM Z DFLTCC
+* Code sanitizers, fuzzing, and coverage
+* GitHub Actions continuous integration on Windows, macOS, and Linux
+ * Emulated CI for ARM, AARCH64, PPC, PPC64, SPARC64, S390x using qemu
+* Unaligned memory read/writes and large bit buffer improvements
+* Includes improvements from Cloudflare and Intel forks
+* Configure, CMake, and NMake build system support
+* Modern C99 syntax and a clean code layout
+* Over 200 CMake unit tests
+
Build
-----