Skip to content

Commit

Permalink
docs: document usage of term colors (and --no-color)
Browse files Browse the repository at this point in the history
  • Loading branch information
domi41 committed Nov 7, 2021
1 parent e4842f7 commit 8d9b410
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,26 +31,31 @@ You can run

and get

#2 Pizza 000000000000011111111222233333333|333333334444444444444444455555555
#1 Chips 000000001111111111111333333333333|333344444444444445555555555555555
#3 Pasta 000000000000000001111111111111111|111122223333333333333333355555555

Legend: 0=reject 1=poor 2=fair 3=good 4=very good 5=excellent
![Merit profiles in ASCII art, with colors](example/screenshot_merit_color.png)


You probably want to `--sort` the proposals by their rank as well:

#1 Chips 000000001111111111111333333333333|333344444444444445555555555555555
#2 Pizza 000000000000011111111222233333333|333333334444444444444444455555555
#3 Pasta 000000000000000001111111111111111|111122223333333333333333355555555

Legend: 0=reject 1=poor 2=fair 3=good 4=very good 5=excellent
./mj example.csv --sort

![Merit profiles in ASCII art, with colors, and sorted](example/screenshot_merit_color_sorted.png)

or use `-` to read from `stdin`:

cat example.csv | mj - --sort


You can also disable color with the flag `--no-color`:

./mj example.csv --no-color

#2 Pizza 000000000000011111111222233333333|333333334444444444444444455555555
#1 Chips 000000001111111111111333333333333|333344444444444445555555555555555
#3 Pasta 000000000000000001111111111111111|111122223333333333333333355555555

Legend: 0=reject 1=poor 2=fair 3=good 4=very good 5=excellent


### Balancing

Majority Judgment, to stay fair, requires tallies to be balanced ; **all proposals must have received the same amount of judgments**.
Expand Down
Binary file added example/screenshot_merit_color.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added example/screenshot_merit_color_sorted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8d9b410

Please sign in to comment.