You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
uwuifyy/README.md

247 lines
6.5 KiB
Markdown

3 years ago
# uwuifyy
3 years ago
[![build](https://github.com/sgoudham/uwuifyy/actions/workflows/build.yml/badge.svg)](https://github.com/sgoudham/uwuifyy/actions/workflows/build.yml)
[![crate.io](https://img.shields.io/crates/v/uwuifyy)](https://crates.io/crates/uwuifyy)
[![downloads](https://img.shields.io/crates/d/uwuifyy)](https://crates.io/crates/uwuifyy)
[![license](https://img.shields.io/github/license/sgoudham/uwuifyy)](LICENSE)
3 years ago
> A robust, customizable, blazingly-fast, efficient and easy-to-use command line application to uwu'ify your text!
3 years ago
>
3 years ago
![](logo/uwuifyy-logo.png)
3 years ago
>
3 years ago
> Logo Credits: Jade Nelson
3 years ago
## Table Of Contents
- [uwuifyy](#uwuifyy)
* [About](#about)
* [Features](#features)
* [Installation](#installation)
3 years ago
* [Homebrew](#homebrew)
* [AUR](#aur)
3 years ago
* [Binaries](#binaries)
+ [Windows](#windows)
+ [Linux \ macOS](#Linux-\-macOS)
3 years ago
* [Rust \ Cargo](#Rust-\-Cargo)
3 years ago
* [Usage](#usage)
3 years ago
+ [Text Input to Text Output](#text-input-to-text-output)
+ [Text Input to File Output](#text-input-to-file-output)
+ [File Input to File Output](#file-input-to-file-output)
3 years ago
* [Benchmarks](#benchmarks)
3 years ago
+ [The Complete Works of William Shakespeare](#the-complete-works-of-william-shakespeare)
+ [300k+ Tokyo 2020\21 Olympics Tweets](#300k+-tokyo-2020\21-olympics-tweets)
3 years ago
+ [3.5M Tiktok Google Play Reviews](#35m-tiktok-google-play-reviews)
+ [3.6M Amazon Reviews And Ratings](#36m-amazon-reviews-and-ratings)
* [License](#license)
* [Acknowledgement](#acknowledgement)
## About
Have you ever wanted to uwu'ify text and large files at blazing fast speeds? Well! You came to the right
place! `uwuifyy`
allows you to _uwu'ify_ text and files from within your own terminal in an _extremely_ fast manner!
## Features
3 years ago
- [x] _**BLAZINGLY FAST**_ (Check out -> [Benchmarks](#benchmarks))
3 years ago
- [x] Seeded by default to allow for reproducible results
3 years ago
- [x] Excludes URL's & Emails
3 years ago
- [x] UwU'ify files available locally on disk
- [x] Completely customisable modifiers
3 years ago
## Installation
3 years ago
3 years ago
### Homebrew
For `macOS` users, installation through [Homebrew](https://brew.sh/) is recommended.
```shell
$ brew tap sgoudham/tap
$ brew install uwuifyy
```
### AUR
`Arch Linux` users can install `uwuifyy` through the [AUR](https://aur.archlinux.org/) using an [AUR helper](https://wiki.archlinux.org/title/AUR_helpers).
```shell
$ paru uwuifyy
```
3 years ago
### Binaries
Binaries for **Windows**, **macOS** & **Linux** are available with every
single [release](https://github.com/sgoudham/uwuifyy/releases)
3 years ago
3 years ago
### Windows
3 years ago
3 years ago
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
3 years ago
$ setx path "%path%;C:\your\path\here\bin"
3 years ago
```
4. Refresh command line and verify installation
```shell
3 years ago
$ uwuifyy --help
3 years ago
```
### Linux \ macOS
3 years ago
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
3 years ago
$ tar -xf uwuifyy-x86_64-unknown-linux-gnu.tar.gz
$ tar -xf uwuifyy-x86_64-unknown-linux-musl.tar.gz
3 years ago
# macOS
3 years ago
$ tar -xf uwuifyy-x86_64-apple-darwin.tar.gz
3 years ago
```
3 years ago
3. Move into `~/bin`
3 years ago
```shell
# Create ~/bin if it does not exist
3 years ago
$ mkdir -p ~/bin
$ mv uwuifyy ~/bin
3 years ago
```
4. Set permissions for executable
```shell
3 years ago
$ chmod 755 ~/bin/uwuifyy
3 years ago
```
5. Update `PATH` to use globally
```shell
# Linux
3 years ago
$ echo 'export PATH=~/bin:$PATH' >> ~/.bashrc
$ source ~/.bashrc
3 years ago
# macOS
3 years ago
$ echo 'export PATH=~/bin:$PATH' >> ~/.bash_profile
$ source ~/.bash_profile
3 years ago
```
6. Verify installation
```shell
3 years ago
$ uwuifyy --version
uwuifyy 0.3.0
3 years ago
```
3 years ago
## Rust \ Cargo
3 years ago
Alternatively, if using Rust's package manager, `Cargo`, all that is needed is
```shell
3 years ago
$ cargo install uwuifyy
```
3 years ago
If you do not have `Cargo` available on your machine, you can download it as part of
3 years ago
Rust [here](https://www.rust-lang.org/tools/install)
3 years ago
3 years ago
## Usage
3 years ago
```commandline
3 years ago
$ uwuifyy --help
3 years ago
USAGE:
uwuifyy.exe [OPTIONS] <--text <TEXT>|--infile <FILE>>
OPTIONS:
3 years ago
-t, --text <TEXT> The text to uwu'ify
3 years ago
-i, --infile <FILE> The file to uwu'ify
-o, --outfile <FILE> The file to output uwu'ified text
3 years ago
--ascii-only The uwu'ified text will only include ASCII faces
--unicode-only The uwu'ified text will only include UTF-8 faces
-r, --random The flag to enable randomized uwu'ified text
3 years ago
-w, --words <VALUE> The modifier to determine how many words to be uwu'ified [default: 1]
-f, --faces <VALUE> The modifier for uwu faces e.g hello -> (^-^*)/ hewwo [default: 0.05]
3 years ago
-a, --actions <VALUE> The modifier for actions e.g *shuffles over* [default: 0.125]
-s, --stutters <VALUE> The modifier for stutters e.g b-baka! [default: 0.225]
-h, --help Print help information
-V, --version Print version information
```
3 years ago
3 years ago
### Text Input to Text Output
3 years ago
3 years ago
![](examples/gifs/text-input-to-text-output.gif)
3 years ago
### Text Input to File Output
3 years ago
![](examples/gifs/text-input-to-file-output.gif)
3 years ago
### File Input to File Output
3 years ago
![](examples/gifs/text-file-to-file-output.gif)
3 years ago
3 years ago
## Benchmarks
3 years ago
3 years ago
- Benchmarks/Tests carried out on a `Dell XPS 15`
3 years ago
- CPU: `11th Gen Intel(R) Core(TM) i7-11800H @ 2.30GHz`
- SSD: `NVMe Micron 2300 1TB`
### The Complete Works of William Shakespeare
- [Dataset](https://www.kaggle.com/kewagbln/shakespeareonline)
- Size: `5.46 MiB`
3 years ago
- Time Taken: `< 1s`
3 years ago
![](examples/gifs/william-shakespeare.gif)
### 300k+ Tokyo 2020\21 Olympics Tweets
3 years ago
- [Dataset](https://www.kaggle.com/amritpal333/tokyo-olympics-2021-tweets)
- Size: `98.54 MiB`
3 years ago
- Time Taken: `1s`
3 years ago
![](examples/gifs/tokyo-2020-olympics-tweets.gif)
### 3.5M Tiktok Google Play Reviews
- [Dataset](https://www.kaggle.com/shivamb/35-million-tiktok-mobile-app-reviews)
- Size: `543.02 MiB`
- Time Taken: `4s`
3 years ago
![](examples/gifs/tiktok_app_reviews.gif)
### 3.6M Amazon Reviews And Ratings
- [Dataset](https://www.kaggle.com/bittlingmayer/amazonreviews?select=train.ft.txt.bz2)
- Size: `1.6 GiB`
3 years ago
- Time Taken: `21s`
- **DISCLAIMER:** The input is a 1.6GB file and the output is a 2.2GB file. They are not included in the repo.
3 years ago
![](examples/gifs/amazon-ratings-reviews.gif)
## License
[MIT License](LICENSE)
## Acknowledgement
This project is inspired from one of many existing normal to uwu converters:
[Uwuifier](https://github.com/Schotsl/Uwuifier-node)