diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index e69de29..0000000 diff --git a/Cargo.toml b/Cargo.toml index 05ac0a5..a308bea 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,6 +3,10 @@ name = "sterling" version = "0.1.0" description = "Converts a given D&D 5e currency value to the Silver Standard." authors = ["Zachary Dziura "] +readme = "README.md" +license = "Unlicense/MIT" +repository = "https://gitlab.com/zcdziura/sterling" +keywords = ["d&d", "coins", "converter", "currency", "5e"] [dependencies] clap = "2.31.1" diff --git a/README.md b/README.md index c48222c..c9362ee 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,25 @@ FLAGS: -V, --version Prints version information ARGS: - ... The value to be converted; should be suffixed with the coin's short-hand abbreviation, i.e. p, g, - e, s, or c. Defaults coin type to 'g'. + ... The value to be converted; should be suffixed with the coin's short-hand + abbreviation, i.e. p, g, e, s, or c. Defaults coin type to 'g'. +``` + +## Examples + +``` +// Convert one hundred platinum coins: +sterling 100p // 10g + +// Convert one hundred platinum, fifty gold coins: +sterling 100p 50g // 10g 5s + +// Convert fifteen thousand copper coins: +sterling 15000c // 1g 50s + +// Convert one platinum, thirty-six gold, twelve electrum, eighty-two silver, and four hundred +// sixty-nine copper coins +sterling 1p 36g 12e 82s 469c // 64s 89c ``` ## Abstract @@ -31,5 +48,20 @@ campaign aught to treat gold similarly! The basis of the Silver Standard treats 1 gold coin from the official D&D 5e source books as 1 silver coin, and that there are one hundred of a given coin to every one of the next highest valued -coin. That's all. Thus, one-hundred fifty copper coins equals one silver and fifty copper coins, -while a suit of heavy plate armor equals fifteen gold coins, rather than fifteen hundred. \ No newline at end of file +coin. That's all. Thus, one hundred fifty copper coins equals one silver and fifty copper coins, +while a suit of heavy plate armor equals fifteen gold coins, rather than fifteen hundred. + +## Installation + +Make sure that you first have `rust` and `cargo` installed onto your computer before downloading +`sterling`. Just follow the simple +[Installation Guide](https://doc.rust-lang.org/cargo/getting-started/installation.html) on the +official Rust language website to install both programs. + +Once `rust` and `cargo` are installed onto your computer, run the following command: + +`cargo install sterling` + +This will install `sterling` into the `.cargo/bin` directory within your User directory +(`/home/YOUR_USER_NAME` on Linux and macOS, `C:\Users\YOUR_USER_NAME` on Windows). Be sure to add +this directory to your PATH. \ No newline at end of file