bottom-0.2.0.0: README.md
# bottom-hs
[](https://github.com/bottom-software-foundation/bottom-hs/actions/workflows/main.yml)
[](https://hackage.haskell.org/package/bottom)
[](https://hackage.haskell.org/package/bottom)
Based off of the hilarious [bottom-rs](https://github.com/bottom-software-foundation/bottom-rs), built to the [Bottom spec](https://github.com/bottom-software-foundation/spec).
## Using the CLI
```sh
$ cabal run bottom -- --help
Bottom translator 0.1.0
Usage: bottom ((-b|--bottomify) | (-r|--regress) | (-V|--version)) <TEXT>
Fantastic (maybe) CLI for translating between bottom and human-readable text
Available options:
-b,--bottomify Translate text to bottom
-r,--regress Translate bottom to human-readable text (futile)
-V,--version Prints version information
-h,--help Show this help text
```
```sh
$ cabal run bottom -- --regress π«β¨β¨π₯Ί,,ππππβ¨β¨π₯Ί,,,,ππππβ¨β¨β¨β¨πππ«β¨β¨π₯Ί,,ππππβ¨β¨β¨ππππβ¨β¨β¨β¨π₯Ί,,πππ«β¨β¨π₯Ί,,ππππβ¨β¨π₯Ί,,,,πππππβ¨β¨π₯Ί,πππ«β¨β¨π₯Ί,,ππππβ¨β¨β¨ππ ππβ¨β¨β¨β¨ππ
γγγ°γ
```
```sh
$ cabal run bottom -- --bottomify Test
πβ¨β¨β¨,,,,ππππ,ππππβ¨π₯Ίππππβ¨π₯Ί,ππ
```
## Usage as a library
See the generated Haddock documentation in Hackage for module documentation.
## Development
Useful commands:
- `cabal run bottom -- --help`: Runs the CLI.
- `cabal repl`: Run the library in the REPL. Loads `Data.Encoding.Bottom` with `-XOverloadedStrings` by default (see `.ghci`).
- `cabal test --enable-coverage`: Run tests, with test coverage.
- `cabal bench`: Run benchmarks.
- `cabal haddock --haddock-all --enable-documentation`: Generate documentation.
- `ormolu --mode inplace $(find . -path ./dist-newstyle -prune -false -o -type f -name '*.hs')`: Format code (see [`ormolu`](https://github.com/tweag/ormolu)).
- `cabal-fmt -i bottom.cabal`: Format `.cabal` file (see [`cabal-fmt`](https://github.com/phadej/cabal-fmt)).
## License
Apache 2.