From fe40ad069ebdb47a92c7e4f73ac5b058d48573ce Mon Sep 17 00:00:00 2001
From: ActuallyHappening <105958073+ActuallyHappening@users.noreply.github.com>
Date: Fri, 4 Aug 2023 19:55:47 +1000
Subject: [PATCH] finish: Polished README.md

---
 README.md       | 17 ++++++++++++++---
 src/board/ui.rs |  8 ++++----
 2 files changed, 18 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 30197db..d363c23 100644
--- a/README.md
+++ b/README.md
@@ -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.
\ No newline at end of file
diff --git a/src/board/ui.rs b/src/board/ui.rs
index 5980afe..07923c1 100644
--- a/src/board/ui.rs
+++ b/src/board/ui.rs
@@ -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");
 		});
 	});
 }