From 6ff00b5a3900d8dfc25b464e60c36eeea7e4d560 Mon Sep 17 00:00:00 2001 From: "Thomas A. Christensen II" <25492070+MillironX@users.noreply.github.com> Date: Tue, 11 Jan 2022 20:03:43 -0600 Subject: [PATCH] Make README more useful --- README.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) diff --git a/README.md b/README.md index a904c88..0a8f81d 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,82 @@ A talking cow library for Julia, based on the [Fedora release of cowsay](https://src.fedoraproject.org/rpms/cowsay). + +## Installation + +You can install straight from the [Julia REPL]. Press `]` to enter [pkg mode], +then: + +```julia +add Cowsay +``` + +## Usage + +Complete usage info can be found in [the documentation]. Cowsay.jl exports two +functions: `cowsay` and `cowthink`, which print an ASCII cow saying or thinking +a message without text wrapping, respectively. + +```julia-repl +julia> using Cowsay +julia> cowsay("Bessie the heifer\nthe queen of all the cows.") + ____________________________ +/ Bessie the heifer: \ +\ the queen of all the cows. / + ---------------------------- + \ ^__^ + \ (oo)\_______ + (__)\ )\/\ + ||----w | + || || + +julia> cowthink("The farmers who have no livestock,\ntheir lives simply aren't the best") + ____________________________________ +( The farmers who have no livestock, ) +( their lives simply aren't the best ) + ------------------------------------ + o ^__^ + o (oo)\_______ + (__)\ )\/\ + ||----w | + || || +``` + +There are also plenty of [unexported Cowfiles] that you can use to customize +your art. + +```julia-repl +julia> cowsay("Super cattle growth hormone can make your beef delicious", cow=Cowsay.udder) + __________________________________________________________ +< Super cattle growth hormone can make your beef delicious > + ---------------------------------------------------------- + \ + \ (__) + o o\ + ('') \--------- + \ \ + | |\ + ||---( )_|| * + || UU || + == == +``` + +You can also change the eyeballs and tongue of your cow. + +```julia-repl +julia> cowsay("You better watch your step\nwhen you know the chips are down!", tongue=" U", eyes="00") + ___________________________________ +/ You better watch your step \ +\ when you know the chips are down! / + ----------------------------------- + \ ^__^ + \ (00)\_______ + (__)\ )\/\ + U ||----w | + || || +``` + +[Julia REPL]: https://docs.julialang.org/en/v1/manual/getting-started/ +[pkg mode]: https://docs.julialang.org/en/v1/stdlib/Pkg/ +[the documentation]: https://millironx.com/Cowsay.jl/stable +[unexported Cowfiles]: https://millironx.com/Cowsay.jl/stable/cows/