From d72450bb3c018e26361f042c954da229d0320422 Mon Sep 17 00:00:00 2001 From: Diego Giagio Date: Wed, 10 Oct 2018 11:01:48 -0400 Subject: [PATCH] Added "How it works" section --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b7b9808..0eb6213 100644 --- a/README.md +++ b/README.md @@ -159,7 +159,25 @@ PS C:\Users\Diego\Devel\myapp> "{0:N2} MB" -f ((Get-Item myapp.exe).Length / 1MB _In progress_ ## How it works -_In progress_ +Warp is a multi-platform tool written in Rust and is comprised of two programs: `warp-runner` and `warp-packer`. + +The final self-contained single binary application consists of two parts: 1) runner and 2) the compressed target application executable and dependencies. + + + +`warp-runner` is a stub application that knows how to find the compressed payload within its own binary, perform exraction to a local cache and execute the target application. + +The extraction process only happens the first time the application is ran, or when the self-contained application binary is updated. + +`warp-packer` is a CLI application that's used to create the self-contained application binary by downloading the correct `warp-runner` for the chosen platform, compressing the target application and generating the final application. + +### Performance +The performance characteristics of the generated self-contained application is roughly the same of original application, except for the first time it's ran as the target application and its dependencies have to be decompressed to a local cache. + +### Cache location +- Linux: `$HOME/.local/share/warp` +- macOS: `$HOME/Library/Application Support/warp` +- Windows: `%LOCALAPPDATA%\warp` ## Authors - Diego Giagio ``