~edwargix/tallyard

6738b50dac2e0b618cc30ee3ebd1939a480d9ab2 — David Florness 5 years ago 6f73331
README: separate install and usage instructions + Arch Linux install
1 files changed, 28 insertions(+), 2 deletions(-)

M README.md
M README.md => README.md +28 -2
@@ 21,7 21,15 @@ everyone is voting simultaneously, such as a club election, [which it was
actually used
for](https://mailman.mines.edu/pipermail/lug/2020-April/000573.html).

# Usage
# Installation

## Arch Linux

```sh
yay -S tallyard
```

## From Source

Ensure you have the [Go](https://golang.org) programming language
installed.  Then:


@@ 30,9 38,27 @@ installed.  Then:
$ git clone https://gitlab.com/edwargix/tallyard
$ cd tallyard
$ make
$ ./tallyard
$ # the tallyard binary is now at ./tallyard
```

# Usage

Once every voter wishing to participate in the election has tallyard installed,
everyone should run it:

```sh
$ tallyard
```

One voter, henceforth called "the master", will then choose "Create Election",
enter the candidates of the election, and share the printed "election key" with
everyone else[^1].  Every voter who is not the master will instead select "Join
Election" and paste the "election key" provided by the master.  Voting will
begin once the master hits the enter key.  However, the master should only do so
once he has received confirmation of a connection from all of the other voters.

[^1]: preferably over a secure medium

# Why Go?

- concurrency