README.md 1.18 KB
Newer Older
Nicolas Lenz's avatar
Nicolas Lenz committed
1
# Mock
Software's avatar
Software committed
2

Nicolas Lenz's avatar
Nicolas Lenz committed
3
![wAR miR jEtzT Zu anSTRENgEnd dA JedeN ZWEiten BUChSTaBeN GRoSS zU scHREiBen](mock.png)
Nicolas Lenz's avatar
Nicolas Lenz committed
4

Nicolas Lenz's avatar
Nicolas Lenz committed
5
There is a **Telegram bot** for Mock available as [\@truemockbot](https://t.me/truemockbot), you can find its source code in the [repository](https://git.eisfunke.com/software/mock-bot-telegram).
6

Nicolas Lenz's avatar
Nicolas Lenz committed
7 8
## Installation

Nicolas Lenz's avatar
Nicolas Lenz committed
9 10
Just clone this repository or download a [release](https://git.eisfunke.com/software/mock/releases) and call

Nicolas Lenz's avatar
Nicolas Lenz committed
11
```
12
$ stack install
Nicolas Lenz's avatar
Nicolas Lenz committed
13
```
Nicolas Lenz's avatar
Nicolas Lenz committed
14

Nicolas Lenz's avatar
Nicolas Lenz committed
15
inside the folder. This will install Mock into `~/.local/bin`, which should be added to `$PATH`.
Nicolas Lenz's avatar
Nicolas Lenz committed
16

Nicolas Lenz's avatar
Nicolas Lenz committed
17
If you're using Arch Linux: there is also an [AUR package](https://aur.archlinux.org/packages/haskell-mock/) available.
Nicolas Lenz's avatar
Nicolas Lenz committed
18 19 20 21 22 23


## Usage

`mock [STYLE] [TEXT]`

Nicolas Lenz's avatar
Nicolas Lenz committed
24
You can get help a list of possible mock styles with `mock`.
Nicolas Lenz's avatar
Nicolas Lenz committed
25

26
If no text or "-" is given, input is read from `stdin`.
Nicolas Lenz's avatar
Nicolas Lenz committed
27 28 29 30

### Examples

```
31
$ mock random This is a great program.
Nicolas Lenz's avatar
Nicolas Lenz committed
32
ThIs Is A greaT PROgrAM.
Nicolas Lenz's avatar
Nicolas Lenz committed
33

34
$ mock space This is a great program.
Nicolas Lenz's avatar
Nicolas Lenz committed
35
T h i s   i s   a   g r e a t   p r o g r a m.
Nicolas Lenz's avatar
Nicolas Lenz committed
36 37
```

Nicolas Lenz's avatar
Nicolas Lenz committed
38
Mock calls can of course be concatenated with pipes:
Nicolas Lenz's avatar
Nicolas Lenz committed
39 40

```
41
$ mock space This is a great program. | mock random
Nicolas Lenz's avatar
Nicolas Lenz committed
42 43 44
T h I S   i S   A   G R e A t   P R o g r a m .
```

Nicolas Lenz's avatar
Nicolas Lenz committed
45

Nicolas Lenz's avatar
Nicolas Lenz committed
46
[![WTFPL-Badge](wtfpl.png)](http://www.wtfpl.net)