zcdziura/sterling
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated README with additional information

Browse source
This commit is contained in:
Zachary Dziura 2018-03-09 23:21:32 -05:00
parent cc1e49c794
commit df2932427c
3 changed files with 40 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

0
.gitlab-ci.yml
View file

4
Cargo.toml
View file

@ -3,6 +3,10 @@ name = "sterling"
version = "0.1.0" version = "0.1.0"
description = "Converts a given D&D 5e currency value to the Silver Standard." description = "Converts a given D&D 5e currency value to the Silver Standard."
authors = ["Zachary Dziura <zcdziura@gmail.com>"] authors = ["Zachary Dziura <zcdziura@gmail.com>"]
readme = "README.md"
license = "Unlicense/MIT"
repository = "https://gitlab.com/zcdziura/sterling"
keywords = ["d&d", "coins", "converter", "currency", "5e"]
[dependencies] [dependencies]
clap = "2.31.1" clap = "2.31.1"

38
README.md
View file

@ -14,8 +14,25 @@ FLAGS:
-V, --version Prints version information -V, --version Prints version information
ARGS: ARGS:
<VALUE>... The value to be converted; should be suffixed with the coin's short-hand abbreviation, i.e. p, g, <VALUE>... The value to be converted; should be suffixed with the coin's short-hand
e, s, or c. Defaults coin type to 'g'. 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 ## 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 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 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, 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. 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.