Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
nenadjakic committed Jan 3, 2024
1 parent 74193bd commit 052057b
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
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.
Binary file added assets/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 052057b

Please # to comment.