Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
particleflux committed Oct 11, 2018
1 parent 08a4de3 commit 96f9182
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.travis.yml export-ignore
.gitattributes export-ignore
.gitignore export-ignore
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]

## 1.0.0 - 2018-10-09
- Initial version


[Unreleased]: https://github.com/particleflux/k3rn3l/compare/1.0.0...HEAD
78 changes: 78 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# kenny

> A kenny-speak en- and decoder
> "Ppfmfp ppmffm Mfmppfmpm! Fmpmfpmppffm pmpmffpmfpmfmppmpm Pmpmppppppppffm!"
[![GitHub release](https://img.shields.io/github/release/particleflux/kenny.svg)](https://github.com/particleflux/kenny/releases)
[![Build Status](https://travis-ci.org/particleflux/kenny.svg?branch=master)](https://travis-ci.org/particleflux/kenny)
[![codecov](https://codecov.io/gh/particleflux/kenny/branch/master/graph/badge.svg)](https://codecov.io/gh/particleflux/kenny)


![](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
```


## Running tests

```
make test
```

### With coverage

```
cmake -DCodeCoverage=ON ..
make coverage-html
```
Binary file added demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 96f9182

Please sign in to comment.