Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
FrostyX committed Dec 29, 2024
1 parent 28349f1 commit ba72382
Showing 1 changed file with 5 additions and 18 deletions.
23 changes: 5 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
# Crooked Rook

[![Package Version](https://img.shields.io/hexpm/v/crooked_rook)](https://hex.pm/packages/crooked_rook)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/crooked_rook/)
All information about the project are in this blog post
- <https://frostyx.cz/posts/shoving-a-chess-engine-up-your-butt>

```sh
gleam add crooked_rook@1
```
```gleam
import crooked_rook
See this two-minute video.

[![Demo](https://i1.ytimg.com/vi/HAxBOoBoVTM/maxresdefault.jpg)](https://www.youtube.com/watch?v=HAxBOoBoVTM)

pub fn main() {
// TODO: An example of the project in use
}
```

## Dependencies

Expand All @@ -22,15 +16,8 @@ cargo install intiface-engine
~/.cargo/bin/intiface-engine --websocket-port 12345 --use-bluetooth-le
```


Further documentation can be found at <https://hexdocs.pm/crooked_rook>.

## Development

```sh
gleam run # Run the project
gleam test # Run the tests
```

## See also

Expand Down

0 comments on commit ba72382

Please sign in to comment.