README.md

bottom-hs

Based off of the hilarious bottom-rs, built to the Bottom spec.

Using the CLI

$ 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

$ cabal run bottom -- --regress 🫂✨✨🥺,,👉👈💖💖✨✨🥺,,,,👉👈💖💖✨✨✨✨👉👈🫂✨✨🥺,,👉👈💖💖✨✨✨👉👈💖💖✨✨✨✨🥺,,👉👈🫂✨✨🥺,,👉👈💖💖✨✨🥺,,,,👉👈💖💖💖✨✨🥺,👉👈🫂✨✨🥺,,👉👈💖💖✨✨✨👉👈 💖💖✨✨✨✨👉👈
がんばれ

$ 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).
• cabal-fmt -i bottom.cabal: Format .cabal file (see cabal-fmt).

License

Apache 2.