README.md 1.88 KB
Newer Older
Seth Price's avatar
Seth Price committed
1 2 3 4 5 6 7 8 9 10 11 12
varlpenis
=========

Generate ASCII-art penis of arbitrary length

Usage
-----

Straight from the program:
```
usage: varlpenis [options]
  options:
Seth Price's avatar
Seth Price committed
13
    -c       output color
Seth Price's avatar
Seth Price committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
    -e num   set length of semen string
    -h       show this message
    -l num   set length of shaft
    -v       show version and copyright info
```

Further documentation can be found on the `varlpenis(6)` man page.

Example
-------

```console
$ ./varlpenis
8==================D~~~
$ ./varlpenis
8=========================D~~
$ ./varlpenis -l 5 -e 8
8=====D~~~~~~~~
```

Installation
------------

```console
$ ./configure
$ make
# make install
```

Should work on UNIX-like systems; untested on Winblows, MS-DOS or anything
else.  Written in ANSI C using only the standard library.

Seth Price's avatar
Seth Price committed
46 47 48 49 50 51
### Configuration

Use any of the following when running `./configure` to control optional
features:

* `--use-color`: Enable colour support using ANSI escape codes
52
* `--use-sysexits`: Use exit values from system's `sysexits.h`
53
* `--use-posixtime`: Use higher-resolution time for better random numbers
Seth Price's avatar
Seth Price committed
54 55
* more to come…

56
Run `./configure --help` for info on installation paths, compilers, etc.
Seth Price's avatar
Seth Price committed
57

Seth Price's avatar
Seth Price committed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
Some notes
----------

This is a pet project I like to tend to when I'm absolutely bored and have
nigh nothing else to do.  That's why, for example, I wrote the configure
script from scratch.  Plus, it teaches me a bit about how it all works.

Contributing
------------

Tabs for indentation, spaces for alignment.  Put brackets on separate lines
for functions and the like; same line for enumerations or `if` clauses.
Just go through the code and copy the style; or,
[send me an e-Mail](ssterling@firemail.cc) if you're really that worried.

Please be descriptive in commits and merge requests; “fixed shit” doesn't
cut it.

Bugs
----

See [BUGS.md](BUGS.md).  Please report any bugs to the
[issue tracker](https://gitlab.com/ssterling/varlpenis/issues).