# cli-timer

[![LICENSE](https://img.shields.io/badge/License-MIT_or_Apache_2.0-blue.svg)](https://github.com/GiorgiBeriashvili/cli-timer#License "Project's LICENSE section")
[![Tokei.rs](https://tokei.rs/b1/github/GiorgiBeriashvili/cli-timer)](https://github.com/GiorgiBeriashvili/cli-timer "Package's total lines of code")
[![Crates.io](https://img.shields.io/crates/v/cli-timer.svg)](https://crates.io/crates/cli-timer "Package's crates.io page")
[![Docs.rs](https://docs.rs/cli-timer/badge.svg)](https://docs.rs/crate/cli-timer "Package's docs.rs page")
[![Build Status](https://dev.azure.com/giorgiberiashvili/cli-timer/_apis/build/status/GiorgiBeriashvili.cli-timer?branchName=master)](https://dev.azure.com/giorgiberiashvili/cli-timer/_build/latest?definitionId=1&branchName=master "Package's Azure Pipelines project")
[![Dependency Status](https://deps.rs/crate/cli-timer/0.3.84/status.svg)](https://deps.rs/crate/cli-timer/0.3.84 "Package's dependency status")

## Description

An interactive command-line interface timer application written in Rust.

---

## Usage

Here is the basic demo of the application:

![Demo](https://raw.githubusercontent.com/GiorgiBeriashvili/cli-timer/master/assets/demo.png)

---

## Building

In order to build cli-timer, you need to have [Rust](https://www.rust-lang.org "Rust programming language's official website") programming language installed on your system. To install Rust (alongside Cargo, which comes bundled with Rust), it's best to follow the [official installation steps](https://www.rust-lang.org/tools/install "Official guide to install Rust").

Building is guaranteed to work with Rust version 1.36.0 (a53f9df32 2019-07-03).

```sh
# Clone the repository
git clone https://github.com/GiorgiBeriashvili/cli-timer
cd cli-timer

# Compile the debug version
cargo build

# Run in the debug mode and print the help information
cargo run -- -h
```

---

## Changelog

All notable changes to this project will be documented in the [CHANGELOG.md](https://github.com/GiorgiBeriashvili/cli-timer/blob/master/CHANGELOG.md "Project's CHANGELOG.md file") file.

---

## License

cli-timer is licensed under either of the following, at your option:

* Apache License, Version 2.0 ([LICENSE-APACHE](https://github.com/GiorgiBeriashvili/cli-timer/blob/master/LICENSE-APACHE "Copy of the Apache license (version 2.0)"))
* MIT License ([LICENSE-MIT](https://github.com/GiorgiBeriashvili/cli-timer/blob/master/LICENSE-MIT "Copy of the MIT license"))