Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 3.3 KB

README.md

File metadata and controls

88 lines (58 loc) · 3.3 KB

🎮 cli-hangman

LICENSE Crates.io Docs.rs Dependency Status Rust Workflow

Description

Logo

Command-line interface rendition of hangman.


Usage

Here is the basic usage scenario of the application:

Usage

Works on Linux, macOS and Windows. Simply run the binary executable file and by default it will launch with all of the batteries included.


Building

In order to build cli-hangman, you need to have Rust 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.

It is preferred to build the project with Rust version 1.42.0 (b8cedc004 2020-03-09).

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

# Build the debug version
cargo build

Changelog

All notable changes to this project will be documented in the CHANGELOG.md file.


Acknowledgements

See the ACKNOWLEDGEMENTS.md file for information regarding the tools/resources used while developing the project.


License

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

For information regarding third-party licenses, please refer to license.html file.


Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

For additional information regarding contributions, please refer to CONTRIBUTING.md file.