based/README.md

36 lines
650 B
Markdown
Raw Permalink Normal View History

2022-05-17 00:18:01 +02:00
# based
2022-05-17 00:26:31 +02:00
A commandline tool that lets you encode and decode most of the bases.
2022-05-17 20:58:43 +02:00
Release binary is statically linked via
```sh
2022-05-19 23:55:26 +02:00
cabal v2-build --enable-executable-static -O2
2022-05-17 20:58:43 +02:00
```
2022-05-17 00:26:31 +02:00
## Compilation
2022-05-17 20:58:43 +02:00
* If you want to compile your own build, link it dynamically via
2022-05-17 00:26:31 +02:00
```sh
2022-05-19 23:55:26 +02:00
git clone https://git.stefan.works/whx/based.git
2022-05-17 20:58:43 +02:00
cd based/
cabal install
2022-05-17 00:26:31 +02:00
cabal run
```
2022-05-20 00:14:22 +02:00
## Usage
* Pipe via stdin to transcode
2022-05-20 00:16:17 +02:00
* Modes are __encode__ and __decode__
2022-05-20 00:14:22 +02:00
* Encoding is done in the following way
```sh
echo Hello, World! | based encode --b91
>OwJh>}AQ;r@@Y?FF
```
* Decoding is implicated in the following way
2022-05-20 00:17:12 +02:00
```sh
2022-05-20 00:14:22 +02:00
echo '>OwJh>}AQ;r@@Y?FF' | based --b91
2022-05-20 00:17:12 +02:00
Hello, World!
2022-05-20 00:14:22 +02:00
```