From c445a6e67df1c6d86308a8dc56097b7154ba4dbe Mon Sep 17 00:00:00 2001 From: deadjakk <30613497+deadjakk@users.noreply.github.com> Date: Mon, 25 Jan 2021 15:23:38 -0600 Subject: [PATCH] Update README.md --- client/README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/client/README.md b/client/README.md index 69fa8b9..36ee975 100755 --- a/client/README.md +++ b/client/README.md @@ -1,10 +1,14 @@ -# RustPivot Implant +# RustPivot Implant -Requires the rustup/cargo to build the binary -First edit the 'port' and 'ip' variables in src/main.rs to match the backend +### Building +1. First edit the 'port' and 'ip' variables in src/main.rs to match the backend address configured for server. -Then build with: -cargo build --release --bin implant +2. Then build with: +`cargo build --release --bin implant` +3. Then run with `./implant` or `.\implant.exe` (Windows) -Note: it will build for whatever operating system it is compiled on unless -specified otherwise via the --target flag +### Usage Tips +- After building, run `strip` against the resulting binary to significantly reduce the binary size. +- Look into using LTO and optimization for size to further reduce binary size. +- It will build for whatever operating system it is compiled on unless +specified otherwise via the `--target` flag.