| | |
| ---------------: | ---------------------------------------------------------------------------------- |
| CI | 
|
| Latest Version | 
|
| Documentation | 
|
| Crate Downloads | 
|
| GitHub Downloads | 
|
| Docker Pulls | 
|
| License | 
|
Table of Contents
There's not much to this program. To greet the currently logged in user, run:
```sh
fnichol-cime "$USER" Hello, jdoe! ```
For more help and full usage, use the --help or -h flags:
```sh
fnichol-cime --help ```
There are pre-built binaries available for macOS, Windows, FreeBSD, and a variety of Linux architectures available through the project's GitHub releases.
If a Docker image is more your speed, there is a minimal image published to
Docker Hub at fnichol/fnichol-cime. The entrypoint invokes the binary
directly, so any arguments to docker run will be passed to the program. For
example, to display the full help usage:
```sh
docker run fnichol/fnichol-cime --help ```
If Rust is installed, then installing with Cargo is straight forward with:
console
$ cargo install fnichol-cime
To install from source, you can clone the Git repository, build with Cargo and copy the binary into a destination directory. This will build the project from the latest commit on the main branch, which may not correspond to the latest stable release:
console
$ git clone https://github.com/fnichol/fnichol-cime.git
$ cd fnichol-cime
$ cargo build --release
$ cp ./target/release/fnichol-cime /dest/path/
If you want (or need) to build the CLI from source, the following should not take too long. Note that you'll need a version of Rust (and Cargo which ships with the Rust distributions) before running:
```sh
git clone https://github.com/fnichol/fnichol-cime.git cd fnichol-cime/cli cargo build --release
test it out
./target/release/fnichol-cime ```
This crate executes a highly specialized algorithm to dynamically generate a greeting in english to a given subject. It is serious business.
This crate is on crates.io and can be
used by adding the crate to your dependencies in your project's Cargo.toml
file:
toml
[dependencies]
fnichol-cime = { version = "0.1.0", default-features = false }
Note that the default features include dependencies which are required to build a CLI and are not needed for the library.
Assuming we have a human named Jane:
rust
let greeting = fnichol_cime::greeting("Jane");
// #=> "Hello, Jane!"
| Operating System | Target | Stable Rust |
| ---------------: | ----------------------------- | ------------------------------------------------------------------------------- |
| FreeBSD | x86_64-unknown-freebsd | 
arm-unknown-linux-gnueabihf | 
aarch64-unknown-linux-gnu | 
i686-unknown-linux-gnu | 
i686-unknown-linux-musl | 
x86_64-unknown-linux-gnu | 
x86_64-unknown-linux-musl | 
x86_64-apple-darwin | 
x86_64-pc-windows-msvc | 
| Operating System | Stable Rust | Nightly Rust |
| ---------------: | ------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| FreeBSD | 
Note: The Minimum Supported Rust Version (MSRV) is also tested and can be viewed in the CI dashboard.
| | Status |
| ------ | ----------------------------------------------------- |
| Lint | 
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to fnichol@nichol.ca.
If you have any problems with or questions about this project, please contact us through a GitHub issue.
You are invited to contribute to new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
See the [changelog] for a full release history.
Created and maintained by Fletcher Nichol (fnichol@nichol.ca).
Licensed under the Mozilla Public License Version 2.0 (LICENSE.txt).
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the MIT license, shall be licensed as above, without any additional terms or conditions.