Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/particleflux/kenny

A kenny-speak en- and decoder
https://github.com/particleflux/kenny

c cli command-line decoding encoding fun kenny linux southpark utility

Last synced: 3 months ago
JSON representation

A kenny-speak en- and decoder

Awesome Lists containing this project

README

        

![logo](kenny.png)

# kenny

> A kenny-speak en- and decoder

> "Ppfmfp ppmffm Mfmppfmpm! Fmpmfpmppffm pmpmffpmfpmfmppmpm Pmpmppppppppffm!"

[![GitHub release](https://img.shields.io/github/release/particleflux/kenny)](https://github.com/particleflux/kenny/releases)
[![CircleCI](https://circleci.com/gh/particleflux/kenny/tree/master.svg?style=shield)](https://circleci.com/gh/particleflux/kenny/tree/master)
[![codecov](https://codecov.io/gh/particleflux/kenny/branch/master/graph/badge.svg)](https://codecov.io/gh/particleflux/kenny)

![demo](demo.gif)

## Usage

```
Usage: kenny [OPTION]... [FILE]
Kenny encode or decode FILE, or standard input, to standard output.

With no FILE, or when FILE is -, read standard input.

-d, --decode decode data
```

### Example

Working on STDIN:

```
$ echo 'Oh my God! They killed Kenny!' | kenny
Ppfmfp ppmffm Mfmppfmpm! Fmpmfpmppffm pmpmffpmfpmfmppmpm Pmpmppppppppffm!
```

Encoding the contents of a file:

```
$ cat test.txt
Hello World
$ kenny test.txt
Mfpmpppmfpmfppf Fppppfpffpmfmpm
```

Decoding:

```
$ echo "pmpmppppppppffm" | kenny -d
kenny
```

## Installation

### Compiling from source

```
git clone https://github.com/particleflux/kenny.git
cd kenny
mkdir build && cd build
cmake ..
make
sudo make install
```

### Gentoo

There is an ebuild available in my [personal overlay]:

```
sudo layman -o https://github.com/particleflux/overlay/raw/master/repositories.xml -f -a particleflux
emerge -a app-misc/kenny
```

## Running tests

```
make test
```

### With coverage

```
cmake -DCodeCoverage=ON ..
make coverage-html
```

[personal overlay]: https://github.com/particleflux/overlay