update README.md

This commit is contained in:
AustrianToast 2024-02-14 00:33:20 +01:00
parent 5c780a75eb
commit ae66a0d641
No known key found for this signature in database
GPG Key ID: 5CD422268E489EB4

View File

@ -2,3 +2,24 @@
This is a project which has similar goals as https://gitea.hopeless-cloud.xyz/ProfessionalUwU/chksum has.
This aims to fix all the problems that his has and make the finding of all files independend of the rest.
## How to Use
You will need to cmake and it will need to be at least version 3.28.
You can check what version your cmake is with
```bash
cmake --version
```
Then we will clone the repo and go into it
```bash
git clone https://gitea.hopeless-cloud.xyz/AustrianToast/chksum_cpp.git && cd chksum_cpp
```
After that is done you just need to run
```bash
cmake . && cmake --build .
```
This will produce some junk because of cmake, but most importantly it should create a binary called chksum.
Here is an example of how to use it
```bash
./chksum /tmp
```