Skip to content

Commit

Permalink
Update demo
Browse files Browse the repository at this point in the history
theoforger committed Sep 18, 2024
1 parent 0ba0d57 commit 7c51ccf
Showing 3 changed files with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# 🔮 Mastermind - A Second Brain for Spymasters

Mastermind is a CLI tool designed to generate clue words for spymasters in the game of **Codenames**, leveraging large language models (LLMs) of your choice.
Mastermind is a CLI tool designed to generate clue words for spymasters in the game of **Codenames**, leveraging large language models (LLMs) of your choice!

Written in Rust, because why not?
Written in Rust 🦀, because why not?

![GitHub License](https://img.shields.io/github/license/theoforger/mastermind)

<img src="demo.gif" width="75%" alt="A gif demo of the basic functions of this program."/>
<img src="images/demo.gif" alt="A gif demo of the basic functions of this program."/>

## 💻 Usage

To get started, prepare two text files:

1. **Words to Link Together**: Contains the words from your own team.
2. **Words to Avoid**: Contains:
1. **Words to Link Together** - Contains the words from your own team.
2. **Words to Avoid** - Contains:
- Your opponent's words
- Neutral words
- The assassin word

Each file should have one word per line. Refer to the [examples](examples) directory for sample files.
One word per line. Refer to the [examples](examples) directory for sample files.

Run the tool with:

@@ -43,7 +43,9 @@ Feel free to run the program multiple times to get the best result!
- `rust`
- `cargo`

Install them using [`rustup`](https://www.rust-lang.org/tools/install), or through your package manager (note: some distributions may package them separately).
Installing via [`rustup`](https://www.rust-lang.org/tools/install) is recommended.

You may also get them from your package manager (note: some distributions may package them separately).

### Clone the Repository

Binary file removed demo.gif
Binary file not shown.
Binary file added images/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7c51ccf

Please sign in to comment.