]> git.gir.st - base65536.git/blob - README.md
Removed long options in favour of `getopt()`, changed comment style to c89, fixed...
[base65536.git] / README.md
1 # base65536
2 Reimplementation of [ferno][1]'s [`base65536`][2] in C for UNIXoid shells.
3
4 ## Why
5 * Why not?
6 * beat [Twitter][3] and pack your tweet with 280 characters!
7 * Annoy your friends!
8
9 ## Building
10 To generate the binary, run `make`.
11 If you want long options (e.g. --decode), enable `-DLONG_OPT`.
12 To automatically run the included tests, run `make test`. (will rebuild)
13 You can copy the resulting `base65536` file to a directory in your `$PATH`.
14
15 ## Usage
16 `base65536` uses GNU's [`base64`][4] tool as a reference and therefore has the
17 same command line arguments. This means, you can either pipe data in or give a
18 file as an argument.
19
20 ### 'Hello World'-Example:
21
22 echo -n "Hello World" | ./base65536
23
24 will output:
25
26 驈ꍬ啯𒁗ꍲᕤ
27
28 ## License
29 `base65536` is released under the GNU General Public License, version 3.
30 See `LICENSE` for details.
31 © 2016 Tobias Girstmair, [isticktoit.net][5]
32
33 ## In other Languages
34 * [JavaScript](https://github.com/ferno/base65536)
35 * [Python](https://github.com/Parkayun/base65536)
36 * [Go](https://github.com/Nightbug/go-base65536)
37 * [Ruby](https://github.com/Nightbug/base65536-ruby)
38 * [PHP](https://github.com/hevertonfreitas/base65536)
39
40 [1]: https://github.com/ferno/
41 [2]: https://github.com/ferno/base65536
42 [3]: https://twitter.com/girstmair
43 [4]: http://linux.die.net/man/1/base64
44 [5]: http://isticktoit.net/
Imprint / Impressum