rusty_chess_clock 1.0.2

A simple chess clock implementation in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# Rusty Chess Clock

This is a simple chess clock implementation in Rust. It can be used either as a command-line tool (UNIX only) or with a GUI.

## Features

### GUI

The chess clock GUI features a simple settings menu which allows the user to set several options alongside the chess clock itself.

![Screenshot of the chess clock GUI settings menu](./images/settings.png)

![Screenshot of the chess clock GUI clock screen](./images/clock.png)

### Command Line

The features of the CLI version are similar to those of the GUI version.

![Screenshot of the chess clock CLI](./images/cli.png)

## Installation

To install the library, which has no dependencies other than the Rust compiler,
run the following command in your terminal.

```bash
cargo install --git https://github.com/michaelbennett99/rusty_chess_clock.git
```

### GUI

The GUI module requires the `gui` feature to be enabled. To build the GUI module, run:

```bash
cargo build --bin chess_clock --features gui --release
```

This will create an executable in the `target/release` directory.

### Command Line (UNIX only)

The command line module requires the `cli` feature to be enabled. To build the command line module, run:

```bash
cargo build --bin chess_clock_cli --features cli --release
```

This will create an executable in the `target/release` directory.