Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TommysG authored Sep 24, 2021
1 parent dfa37cc commit 3a9d0b6
Showing 1 changed file with 45 additions and 3 deletions.
48 changes: 45 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,45 @@
# MG
Lepaleo & TommysG
This is the classic memory card game made with JavaFX
# Memory Card game

A fun & interactive card game where you can practice your brain. Check out the screenshots and the instructions below.


## Download && Play

Coming soon!


## Building from source

* Java 8 or Java 10

```
git clone https://github.com/TommysG/memory-card-game.git
```

The project will build & run smoothly because JavaFX is integrated in these two JDK versions.

* Java 11 or newer

```
git clone https://github.com/TommysG/memory-card-game.git
```

Then you have to download JavaFX externally and add it as a module.
You can find more info [here](https://openjfx.io/index.html).

## Screenshots

### Game menu
<img width="800" src="https://github.com/TommysG/memory-card-game/blob/master/screenshots/menu.png">

### Single Mode
<img width="800" src="https://github.com/TommysG/memory-card-game/blob/master/screenshots/game.png">

### Game modes
<img width="800" src="https://github.com/TommysG/memory-card-game/blob/master/screenshots/modes.png">

### Settings menu
<img width="800" src="https://github.com/TommysG/memory-card-game/blob/master/screenshots/settings.png">

### Highscore board
<img width="800" src="https://github.com/TommysG/memory-card-game/blob/master/screenshots/screenshot1.png">

0 comments on commit 3a9d0b6

Please sign in to comment.