Skip to content

Commit

Permalink
finish: Polished README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ActuallyHappening committed Aug 4, 2023
1 parent b6548a0 commit fe40ad0
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 7 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,22 @@
View an up-to-date online version here: https://caleb-msrc-q11.netlify.app.
Download a desktop version in this repo's releases page: https://github.com/ActuallyHappening/ChessBois/releases

## What is it?
CAP is a program to visually analyse chess boards in the context of knights tours.
It can quickly and easily construct board topologies which you can then search for knight's tours on,
by simply hovering your mouse on a start location.

**It is 100% Rust!**

You can download a desktop version, which also supports uploading and downloading board solutions.
If you are on Windows, download the `.zip` file. If you are on macOS, download the `.dmg` file.
You will need to disable security to run them, as they are not signed.

## To run yourself from source
First install rust.
Prerequisites: `brew install llvm && cargo install cargo-watch && cargo install trunk` (macos only).
Prerequisites: `brew install llvm && cargo install cargo-watch && cargo install trunk` (macos/linux only).

Clone local dep: `git clone https://github.com/ActuallyHappening/bevy_egui_controls.git`
Clone local dep (at root of project): `git clone https://github.com/ActuallyHappening/bevy_egui_controls.git`

Then, `cargo r` and `cargo w` run and reload the project respectively.
Then, `cargo r` / `cargo w` to run and reload the project respectively.
`trunk serve` to view in a web browser.
8 changes: 4 additions & 4 deletions src/board/ui.rs
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@ pub fn left_ui(mut contexts: EguiContexts, state: ResMut<SharedState>) {

ui.collapsing("About", |ui| {
ui.label("This project was created to advance the knowledge of humanity in the field of chess, \
To entertain its programmer, \
And to show that 100% Rust projects are possible and fun.");
ui.hyperlink_to("Link to source code: ", "https://github.com/ActuallyHappening/ChessBois");
ui.hyperlink_to("To download a desktop version: ", "https://github.com/ActuallyHappening/ChessBois/releases");
to entertain its programmer, \
and to show that 100% Rust projects are possible and fun.");
ui.hyperlink_to("Link to source code", "https://github.com/ActuallyHappening/ChessBois");
ui.hyperlink_to("To download a desktop version", "https://github.com/ActuallyHappening/ChessBois/releases");
});
});
}
Expand Down

0 comments on commit fe40ad0

Please sign in to comment.