diff --git a/README.md b/README.md index 5ab1986..061ad50 100644 --- a/README.md +++ b/README.md @@ -44,11 +44,90 @@ allows you to _uwu'ify_ text and files from within your own terminal in an _extr ## Installation -**Binaries will be available soon™** +Binaries for **Windows**, **macOS** & **Linux** are available with every single [release](https://github.com/sgoudham/uwuifyy/releases) -If using Rust's package manager, `Cargo`, all that is needed is +### Windows -```commandline +1. Download either `uwuifyy-x86_64-pc-windows-msvc.zip` or `uwuifyy-x86_64-pc-windows-gnu.zip` + + +2. Extract into `\bin` folder at `C:\your\path\here\` + +``` +C: +|__your + |__path + |__here + |__bin + |__uwuifyy.exe +``` + +3. Set `uwuifyy.exe` in your path to access it globally + +```shell +setx path "%path%;C:\your\path\here\bin" +``` + +4. Refresh command line and verify installation + +```shell +uwuifyy --help +``` + +### Linux / macOS + +1. Download `uwuifyy-x86_64-unknown-linux-gnu.tar.gz` or `uwuifyy-x86_64-unknown-linux-musl.tar.gz` + or `uwuifyy-x86_64-apple-darwin.tar.gz` + + +2. Extract into your local directory + +```shell +# Linux +tar -xf uwuifyy-x86_64-unknown-linux-gnu.tar.gz +tar -xf uwuifyy-x86_64-unknown-linux-musl.tar.gz + +# macOS +tar -xf uwuifyy-x86_64-apple-darwin.tar.gz +``` + +3. Movie into `~/bin` + +```shell +# Create ~/bin if it does not exist +mkdir -p ~/bin +mv uwuifyy ~/bin +``` + +4. Set permissions for executable + +```shell +chmod 755 ~/bin/uwuifyy +``` + +5. Update `PATH` to use globally + +```shell +# Linux +echo 'export PATH=~/bin:$PATH' >> ~/.bashrc +source ~/.bashrc + +# macOS +echo 'export PATH=~/bin:$PATH' >> ~/.bash_profile +source ~/.bash_profile +``` + +6. Verify installation + +```shell +uwuifyy --help +``` + +### Rust/Cargo + +Alternatively, if using Rust's package manager, `Cargo`, all that is needed is + +```shell cargo install uwuifyy ``` @@ -57,7 +136,7 @@ Rust [here](https://www.rust-lang.org/tools/install) ## Usage -```commandline +```shell USAGE: uwuifyy.exe [OPTIONS] <--text |--infile > @@ -76,14 +155,14 @@ OPTIONS: ### Text Input to Text Output -```commandline +```shell C:\Your\Path\Here> uwuifyy --text "According to all known laws of aviation, there is no way a bee should be able to fly." > Accowding to aww knyown waws of aviation, thewe xDD is nyo way :3 a bee shouwd be abwe to *screams* fwy. ``` ### Text Input to File Output -```commandline +```shell C:\Your\Path\Here> uwuifyy --text "According to all known laws of aviation, there is no way a bee should be able to fly." --outfile your/path/here/outfile.txt [00:00:00] [############################################################] 104B/104B (0s) UwU'ifying Complete! ``` @@ -102,7 +181,7 @@ your/path/here/infile.txt According to all known laws of aviation, there is no way a bee should be able to fly. ``` -```commandline +```shell PS D:\Programming\Personal\uwuifyy> uwuifyy --infile your/path/here/infile.txt --outfile your/path/here/outfile.txt [00:00:00] [############################################################] 85B/85B (0s) UwU'ifying Complete! ```