Skip to content

Commit

Permalink
Edit README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ruben9922 committed Apr 25, 2023
1 parent f3ae176 commit 8c69142
Showing 1 changed file with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Snake
# Reversi

[![ruben-reversi](https://snapcraft.io/ruben-reversi/badge.svg)](https://snapcraft.io/ruben-reversi)
[![goreleaser](https://github.com/Ruben9922/reversi/actions/workflows/release.yml/badge.svg)](https://github.com/Ruben9922/reversi/actions/workflows/release.yml)
[![GitHub](https://img.shields.io/github/license/Ruben9922/reversi)](https://github.com/Ruben9922/reversi/blob/master/LICENSE)
[![Release](https://github.com/Ruben9922/reversi/actions/workflows/release.yml/badge.svg)](https://github.com/Ruben9922/reversi/actions/workflows/release.yml)

Command-line version of the classic Reversi / Othello game.

Expand All @@ -11,11 +12,32 @@ It supports both the modern Othello rules and the historical Reversi rules. The

## Usage

### Using binary
Download the latest binary for your OS and architecture from the [releases page](https://github.com/Ruben9922/reversi/releases). Simply run it; no installation needed.
### Using a binary
Download the latest binary for your OS and architecture from the [releases page](https://github.com/Ruben9922/reversi/releases). Simply extract and run it; no installation needed.

### Using Snap (Linux or Mac only)
If using Linux or Mac (with Snap installed), you can install via Snap using either your desktop store or the command line:
#### Windows
1. Extract the zip archive.
2. Navigate into the folder where you extracted the files.
3. Run `reversi.exe`.

#### Linux or macOS
Extract the tar.gz archive using a GUI tool or the command line, e.g.:
```bash
tar -xvzf reversi_0.1.1_linux_x86_64.tar.gz --one-top-level
```

Navigate into the folder where you extracted the files, e.g.:
```bash
cd reversi_0.1.1_linux_x86_64/
```

Run the program:
```bash
./reversi
```

### Using Snap (Linux or macOS only)
If using Linux or macOS (with Snap installed), you can install via Snap using either the desktop store or the command line:
```bash
sudo snap install ruben-reversi
```
Expand Down

0 comments on commit 8c69142

Please sign in to comment.