Skip to content

Commit

Permalink
Add documentation link; crossterm mention to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxLaumeister authored May 13, 2024
1 parent 65f5b20 commit ac414dd
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Rusty FreeCell

A [FreeCell](https://en.wikipedia.org/wiki/FreeCell) solitaire card game in Rust, with a text-based user interface.
A [FreeCell](https://en.wikipedia.org/wiki/FreeCell) solitaire card game in Rust, with a text-based user interface. Uses [crossterm](https://github.com/crossterm-rs/crossterm) for TUI output.

## How To Play

Expand Down Expand Up @@ -37,3 +37,9 @@ To build and run Rusty FreeCell from source, [install Rust using rustup](https:/
```
cargo run --release
```

## Documentation

See: [rusty-freecell documentation](https://www.maxlaumeister.com/software/rusty-freecell/docs/rusty_freecell/)

Documentation for rusty-freecell is automatically generated from the `main` branch using a GitHub action.

0 comments on commit ac414dd

Please sign in to comment.