ddidderr/zstd-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated documentation regarding build systems

Browse Source
This commit is contained in:
Yann Collet
2022-06-19 11:12:16 -07:00
parent b7b7edb3a3
commit b33ef91694
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -1
View File
@@ -124,14 +124,23 @@ Dictionary gains are mostly effective in the first few KB. Then, the compression
## Build instructions ## Build instructions
`make` is the officially maintained build system of this project.
All other build systems are "compatible" and 3rd-party maintained,
they may feature small differences in advanced options.
When your system allows it, prefer using `make` to build `zstd` and `libzstd`.
### Makefile ### Makefile
If your system is compatible with standard `make` (or `gmake`), If your system is compatible with standard `make` (or `gmake`),
invoking `make` in root directory will generate `zstd` cli in root directory. invoking `make` in root directory will generate `zstd` cli in root directory.
It will also create `libzstd` into `lib/`.
Other available options include: Other available options include:
- `make install` : create and install zstd cli, library and man pages - `make install` : create and install zstd cli, library and man pages
- `make check` : create and run `zstd`, tests its behavior on local platform - `make check` : create and run `zstd`, test its behavior on local platform
The `Makefile` follows the [GNU Standard Makefile conventions](https://www.gnu.org/prep/standards/html_node/Makefile-Conventions.html),
allowing staged install, standard flags, directory variables and command variables.
### cmake ### cmake