From de0fcd5182c2204b11d37773713ff18de7a3fd92 Mon Sep 17 00:00:00 2001 From: specCon18 Date: Thu, 21 Sep 2023 05:03:51 -0400 Subject: [PATCH] updated README.md --- README.md | 24 +++++++++++++++++++++--- windows_build_reqs.ps1 | 0 2 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 windows_build_reqs.ps1 diff --git a/README.md b/README.md index 1afa4c1..a79c685 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,28 @@ Interface for developers and users to interact with many common archive formats. # Installation -install with: +### install with Cargo: ```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 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: - add support for the remaining filetypes -- add windows build support diff --git a/windows_build_reqs.ps1 b/windows_build_reqs.ps1 new file mode 100644 index 0000000..e69de29