tgorordo/smithy
1
0
Fork 0
mirror of https://github.com/tgorordo/smithy.git synced 2026-06-12 18:42:13 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Revise README

Browse source 
Updated README to improve clarity and add usage details.
This commit is contained in:
Thomas (Tom) C. Gorordo 2026-05-25 22:25:52 -07:00 • committed by GitHub
parent 18405644d3
commit d1db77c466
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 19 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -33,7 +33,22 @@ executable should give you access to the `smithycmd` CLI command.
this in your shell as `uv run src/smithycmd.py [...]` from within the repo after cloning it locally. this in your shell as `uv run src/smithycmd.py [...]` from within the repo after cloning it locally.
In either case, the command expects the same argument structure: In either case, the command expects the same argument structure:
TODO ```bash
$ uv run src/smithycmd.py --help
Usage: smithycmd.py [OPTIONS] BALLOTS
Compute the Smith set from a box of ranked-choice ballots -- .csv or
.xls(x).
The Smith set is the minimal set of candidates which can beat all others
pairwise (simple ranking majority) - if there is a single winner in the set,
they are guaranteed the Condorcet i.e. Majority winner.
Options:
-b, --show-ballots Show relevant ballots (after selections).
-p, --pretty Pretty-print output.
--help Show this message and exit.
```
If you want a 'None' option in your election, it should be included as a candidate. If you want a 'None' option in your election, it should be included as a candidate.