Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Tohr01 authored Mar 27, 2022
1 parent 0be920a commit 43d5e74
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# ShellSlide - Play 2048 in your shell 🎮
![The game](https://github.com/Tohr01/ShellSlide/blob/main/screenshots/main_game.png)

## Features
- Keep track of your overall highscore
- Easily save and resume your games
![Saving and resuming a game](https://github.com/Tohr01/ShellSlide/blob/main/screenshots/load_game.png)

## Installation (macOS only)
1. Download the latest ZIP file from the [Releases tab](https://github.com/Tohr01/ShellSlide/releases/latest)
2. Unzip and run binary 'ShellSlide'

#### Add ShellSlide to your PATH
1. Move 'ShellSlide' binary to ```/usr/local/bin```
2. Open a Terminal of your choice and type in ```ShellSlide```

## Dependencies
🌈 Coloring done with [Chalk](https://github.com/luoxiu/Chalk) by luoxiu

0 comments on commit 43d5e74

Please sign in to comment.