Skip to content

Commit

Permalink
cleanup readme formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
boldandbrad committed Mar 18, 2024
1 parent 8b37ff7 commit 0d0de53
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,22 @@
*This is a reimplementation and reimagination of my other project [euchre-cli](https://https://github.com/boldandbrad/meeple-cli).*
> [!WARNING]<br>
> **euchre-tui** is currently in **ALPHA**. This means it is highly unstable and
> is missing key features.
# euchre-tui

[![Crates.io](https://img.shields.io/crates/v/euchre-tui)](https://crates.io/crates/euchre-tui)

**euchre-tui** allows you to play euchre in your terminal with a beautifully
Play euchre in your terminal with a beautifully
designed text-based interface.

...but what the heck is even euchre?

Euchre is a team-based trick-taking card game for 4 players that is popular in
the US Midwest, and some other places.

> [!WARNING]<br>
> **euchre-tui** is currently in **ALPHA**. This means it is highly unstable and
> is missing key features.
**Jump to:**
[Demo](#demo) |
[Features](#features) |
[Installation](#install) |
[Getting Started](#getting-started) |
[Configuration](#config) |
[Legal](#legal) |
[FAQ](#faq) |
[Legal](#legal)
<!-- [Documentation](https://boldandbrad.github.io/euchre-tui/) 🔗 -->

## 📼 Demo <a id="demo"></a>
Expand Down Expand Up @@ -51,14 +45,23 @@ cargo install euchre-tui

## 🚀 Getting started <a id="getting-started"></a>

<!-- TODO: add usage instructions -->
> Coming soon.
<!-- TODO: add more usage instructions -->
```bash
euchre
```

## ⚙️ Configuration <a id="config"></a>

<!-- TODO: add configuration guide -->
> Coming soon.
## ❓ FAQ <a id="faq"></a>

### ...but what the heck is even euchre?

Euchre is a team-based trick-taking card game for 4 players that is popular in
the US Midwest, and some other places.

## ⚖️ Legal <a id="legal"></a>

Copyright (c) 2024 Bradley Wojcik. Released under the MIT License. See
Expand Down

0 comments on commit 0d0de53

Please sign in to comment.