| | |
| ---------------: | ---------------------------------------------------------------------------------------- |
| 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 ```
An installer is provided at https://fnichol.github.io/fnichol-cime/install.sh which installs a suitable pre-built binary for common systems such as Linux, macOS, Windows, and FreeBSD. It can be downloaded and run locally or piped into a shell interpreter in the "curl-bash" style as shown below. Note that if you're opposed to this idea, feel free to check some of the alternatives below.
To install the latest release for your system into $HOME/bin:
```console
curl -sSf https://fnichol.github.io/fnichol-cime/install.sh | sh ```
When the installer is run as root the installation directory defaults to
/usr/local/bin:
```console
curl -sSf https://fnichol.github.io/fnichol-cime/install.sh | sudo sh ```
A [nightly] release built from HEAD of the main branch is available which can
also be installed:
```console
curl -sSf https://fnichol.github.io/fnichol-cime/install.sh \ | sh -s -- --release=nightly ```
For a full set of options, check out the help usage with:
```console
curl -sSf https://fnichol.github.io/fnichol-cime/install.sh \ | sh -s -- --help ```
Each release comes with binary artifacts published in GitHub
Releases. The install.sh program downloads its artifacts
from this location so this serves as a manual alternative. Each artifact ships
with MD5 and SHA256 checksums to help verify the artifact on a target system.
A minimal image ships with each release (including a [nightly] built version
from HEAD of the main branch) published to Docker Hub. 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:
```console
docker run fnichol/fnichol-cime --help ```
If Rust is installed on your system, 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/ ```
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.7.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.
