add vhs tape and assets, update readme, add simple makefile

README.md

@@ -1,34 +1,64 @@
+*This is a reimplementation and reimagination of my other project [euchre-cli](https://https://github.com/boldandbrad/meeple-cli).*
+
 # euchre-tui
 
 [![Crates.io](https://img.shields.io/crates/v/euchre-tui)](https://crates.io/crates/euchre-tui)
 
-Euchre is a team-based trick-taking card game for 4 players that is popular in
-the US Midwest, and some other places.
-
 **euchre-tui** allows you to play euchre in your terminal with a beautifully
 designed text-based interface.
 
-<!-- TODO: add gif -->
+...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. Please track the progress of features throughout this
-> README with the following symbols:
-> | Symbol    | Status                    |
-> | -         | -                         |
-> | ✅        | Implemented - stable      |
-> | ✳️        | Implemented - unstable    |
-> | 🚧        | Work in Progress          |
-> | ❌        | Not Started               |
+> is missing key features.
+
+**Jump to:**
+[Demo](#demo) |
+[Features](#features) |
+[Installation](#install) |
+[Getting Started](#getting-started) |
+[Configuration](#config) |
+[Legal](#legal) |
+<!-- [Documentation](https://boldandbrad.github.io/euchre-tui/) 🔗 -->
+
+## 📼 Demo <a id="demo"></a>
 
-<!-- TODO: add install instructions -->
+![demo-gif](assets/demo.gif)
+
+## ✨ Features <a id="features"></a>
+
+<!-- TODO: list completed features -->
+> Coming soon.
 
 ## 📦 Install <a id="install"></a>
 
+### Via [Cargo](https://crates.io)
+
 ```bash
 cargo install euchre-tui
 ```
 
+### Build from source
+
+1. Install [Rust](https://rust-lang.org/tools/install)
+1. Run `git clone https://github.com/boldandbrad/euchre-tui` and `cd euchre-tui`
+1. Run `cargo install --path .`
+1. Ensure `~/.cargo/bin` or `$CARGO_HOME/bin` is in your `$PATH`
+
+## 🚀 Getting started <a id="getting-started"></a>
+
+<!-- TODO: add usage instructions -->
+> Coming soon.
+
+## ⚙️ Configuration <a id="config"></a>
+
+<!-- TODO: add configuration guide -->
+> Coming soon.
+
 ## ⚖️ Legal <a id="legal"></a>
 
 Copyright (c) 2024 Bradley Wojcik. Released under the MIT License. See

assets/mock-game-ui.txt

@@ -30,6 +30,4 @@
 
     Prompts/outputs go here...
 
-    -><-↓↑
-
     →←↓↑

assets/record.tape

@@ -0,0 +1,38 @@
+# Create euchre-tui demo gif and screenshots
+#  VHS syntax reference: https://github.com/charmbracelet/vhs?tab=readme-ov-file#vhs-command-reference
+
+Output assets/demo.gif
+
+Require euchre
+
+Set Shell "zsh"
+Set FontSize 16
+Set FontFamily "Anonymous Pro"
+Set Width 1200
+Set Height 800
+Set PlaybackSpeed 0.5
+Set TypingSpeed 100ms
+
+# run the binary and wait on splash screen
+Type "euchre" Sleep 500ms Enter Sleep 3s
+
+Screenshot assets/splash.png
+
+# navigate to setup screen and wait
+Type "n" Sleep 2s
+
+# type into first input box and wait
+Type "boldandbrad" Sleep 1s Enter Sleep 1s
+
+# type into second input box and wait
+Type "Good guys" Sleep 1s Enter Sleep 1s
+
+Screenshot assets/setup.png
+
+# submit form
+Enter
+
+# watch game begin
+Sleep 10s
+
+Screenshot assets/table.png

makefile

@@ -0,0 +1,8 @@
+install:
+	cargo install --path .
+
+uninstall:
+	cargo uninstall euchre-tui
+
+record:
+	vhs assets/record.tape