-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
74193bd
commit 052057b
Showing
2 changed files
with
25 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,26 @@ | ||
# memory-rs | ||
Memory, matching card game. | ||
Memory game. Terminal game in which you should find all pairs. | ||
|
||
![memory-rs](./assets/preview.png) | ||
|
||
## Overview | ||
Game is develop in rust programming language using ratatui library. It's a terminal game, in which you should find all pairs. | ||
|
||
|
||
## Getting started | ||
|
||
### Compile and run | ||
|
||
1. For rust and cargo installation, follow instruction from rust official site: **https://www.rust-lang.org/**. | ||
2. To build app run **cargo build**. Also, you can start build for release with **cargo build -r** | ||
3. After app is build, run **./target/debug/memory-rs** or if you used **-r** flag **./target/release/memory-rs** | ||
|
||
Also, you can skip bullet 2 and 3 and execute **cargo run** to compile and run application in one step. | ||
|
||
For more information how to build and run rust project, visit official rust site: **https://www.rust-lang.org/**. | ||
|
||
### How to play | ||
When game is started, game will automaticaly start. Left panel contains board with cards and righ panel contains some information how to play. | ||
|
||
## Licence | ||
This project is licensed under the MIT License. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.