Ferris Says

A library for printing out text with Ferris as the mascot!

Build requirements

You only need a stable version of the Rust compiler.

How to use the library

Put the following in your Cargo.toml:

[dependencies]
ferris-says = "0.3.1"

or run:

cargo add ferris-says

Example

The following bit of code will write the byte string to STDOUT

use ferris_says::say;
use std::io::{stdout, BufWriter};

fn main() {
    let out = "Hello fellow Rustaceans!";
    let width = 24;

    let mut writer = BufWriter::new(stdout());
    say(out, width, &mut writer).unwrap();
}

This will print out this when run:

 __________________________
< Hello fellow Rustaceans! >
 --------------------------
        \
         \
            _~^~^~_
        \) /  o o  \ (/
          '_   -   _'
          / '-----' \

How to use the binary

The binary version is called fsays and can be installed with cargo install:

cargo install fsays

It reads input from stdin and prints it out to the console.

fsays 'Hello fellow Rustaceans!'

This will print out this when run:

 __________________________
< Hello fellow Rustaceans! >
 --------------------------
        \
         \
            _~^~^~_
        \) /  o o  \ (/
          '_   -   _'
          / '-----' \

A width can also be specified, if desired.

fsays --width 12 'Hello fellow Rustaceans!'

will result in the following output:

 ______________
/ Hello fellow \
\ Rustaceans!  /
 --------------
        \
         \
            _~^~^~_
        \) /  o o  \ (/
          '_   -   _'
          / '-----' \

You can also use multiple files as input by using the -f/--files flag!

Contributing

See CONTRIBUTING.md for more information.

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Licensing

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Credit

Original Ferris ASCII art by @Diggsey