updated README.md

This commit is contained in:
specCon18 2023-09-21 05:03:51 -04:00
parent cbc66b4df8
commit de0fcd5182
2 changed files with 21 additions and 3 deletions

View file

@ -2,9 +2,28 @@
Interface for developers and users to interact with many common archive formats. Interface for developers and users to interact with many common archive formats.
# Installation # Installation
install with: ### install with Cargo:
```shell ```shell
cargo install sk_extract cargo build --release
```
### Install with nix:
add the flake
call the module
### Install with windows
- Install git
- Install vcpkg
```powershell
git clone https://github.com/microsoft/vcpkg.git
.\bootstrap-vcpkg.bat
```
- Install liblzma via vcpkg
```powershell
vcpkg install liblzma:x64-windows-static-md
```
- Build using:
```powershell
cargo build --release
``` ```
# Examples # Examples
to use the cli run sk_extract [ARCHIVES] to use the cli run sk_extract [ARCHIVES]
@ -186,4 +205,3 @@ thanks to all of the wonderful library devs listed below that have helped the ea
### TODO: ### TODO:
- add support for the remaining filetypes - add support for the remaining filetypes
- add windows build support

0
windows_build_reqs.ps1 Normal file
View file