Skip to content

Commit 384ade4

Browse files
authored
Improve README formatting (#37)
1 parent b8af362 commit 384ade4

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ For LZ4 compressors, LZ4 HC compressors and decompressors, 3 implementations are
4040
available:
4141
- JNI bindings to the original C implementation by Yann Collet,
4242
- a pure Java port of the compression and decompression algorithms,
43-
- a Java port that uses the sun.misc.Unsafe API in order to achieve compression
43+
- a Java port that uses the `sun.misc.Unsafe` API in order to achieve compression
4444
and decompression speeds close to the C implementation.
4545

46-
Have a look at LZ4Factory for more information.
46+
Have a look at [LZ4Factory](https://lz4-java.yawk.at/current/javadoc/net/jpountz/lz4/LZ4Factory) for more information.
4747

4848
## Compatibility notes
4949

@@ -107,9 +107,9 @@ score of 10) hash function.
107107
## Implementations
108108

109109
Similarly to LZ4, 3 implementations are available: JNI bindings, pure Java port
110-
and pure Java port that uses sun.misc.Unsafe.
110+
and pure Java port that uses `sun.misc.Unsafe`.
111111

112-
Have a look at XXHashFactory for more information.
112+
Have a look at [XXHashFactory](https://lz4-java.yawk.at/current/javadoc/net/jpountz/xxhash/XXHashFactory) for more information.
113113

114114
## Compatibility notes
115115

@@ -167,8 +167,8 @@ speed at which they compress/decompress/hash bytes.
167167

168168
Make sure you have a Java 7 installation in your [Maven toolchains.xml](https://maven.apache.org/guides/mini/guide-using-toolchains.html). You may also need a C compiler.
169169

170-
First run git submodule init and then git submodule update to initialize the lz4 submodule in src/lz4.
170+
First run `git submodule init` and then `git submodule update` to initialize the lz4 submodule in `src/lz4`.
171171

172172
Then, run `./mvnw verify`.
173173

174-
Building a full artifact with native libraries for all supported platforms is more complex. We do this through github actions.
174+
Building a full artifact with native libraries for all supported platforms is more complex. We do this through GitHub Actions.

0 commit comments

Comments
 (0)