Skip to content

Commit 3a4eaa0

Browse files
committed
Update README
1 parent b51a078 commit 3a4eaa0

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,19 @@
11
# qCheck [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
22

3-
**Work in progress**
4-
53
A **q**uick alternative to cksfv for generating and verifying CRC32C checksum files(`.sfv`).
64

75
---
86

9-
qCheck accelerates the checksum and checksum-verification process by interfacing
10-
with the `.sfv` file format and using a more modern approach by utilizing both
11-
multi-threaded parallelism and memory-mapped IO to reduce syscall overhead.
12-
13-
qCheck has proven itself to be about **x4** to **x15** times faster than
14-
alternatives such as `rhash` and `cksfv` and reduces CRC32's algorithmic
15-
overhead to the point of being almost entirely bounded by device IO speeds.
7+
qCheck is about **x4** to **x15** times faster than alternatives such as
8+
`rhash` and `cksfv` and reduces algorithmic overhead to being almost
9+
entirely bounded by device IO!
1610
It is recommended to run this program on a fast NVME Solid State Drive to fully
1711
saturate read speed.
1812

1913
---
2014

2115
## Install
16+
2217
### Manual
2318
```
2419
$ git clone https://github.com/Wunkolo/qCheck.git qCheck/src
@@ -28,12 +23,14 @@ $ cmake --build qCheck/build --config Release
2823
```
2924

3025
### Packages
26+
3127
[ArchLinux](https://aur.archlinux.org/packages/qcheck-git)
3228

3329

3430
## Benchmark
3531

3632
Specs:
33+
3734
```
3835
% inxi -IC
3936
CPU: Topology: 10-Core model: Intel Core i9-7900X bits: 64 type: MT MCP L2 cache: 13.8 MiB

0 commit comments

Comments
 (0)