From 2b22feb7dcb0cf7fe5101a96cb2f237b9972eeb3 Mon Sep 17 00:00:00 2001 From: Xevion Date: Sun, 13 Dec 2020 00:22:24 -0600 Subject: [PATCH] update README with improved features info, improve english/formatting --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 397f6d5..f33106f 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,24 @@ ---- +
-**Boids** is a simple simulation project dedicated to showcasing the flocking algorithm (known as *Boids*) in fun and accessible format, complete with sliders, buttons and dropdowns to allow maximum customization. +**Boids** is a simple simulation project dedicated to showcasing the flocking algorithm (known as *Boids*) in a fun and accessible format, complete with sliders, buttons and dropdowns to allow maximum customization. -To download a release, check the [Releases](https://github.com/Xevion/Boids/releases) section and download the appropriate build. **Boids** is built on the Unity Engine, and thus should be fully compatible across a myriad of platforms (although I do not provide Android builds). +## Features + +- Customizable simulation weights +- Handles up to 750 boids simultaneously on modern systems! +- Smoothly animated and simple customization menu +- Clean and informative about menu +- Boid tracking with field of view visuals (Space) +- Performance statistics (CTRL+H, CTRL+G) + +## Installation + +To download a release, check the [Releases](https://github.com/Xevion/Boids/releases) section and download the appropriate build. **Boids** is built on the Unity Engine, and thus should be fully compatible across Windows, Mac & Linux without trouble. + + +## Disclaimer *Note: Boids is extremely early in it's development and only has a fraction of the features I want it to have. Current releases are most definitely not even close to what I want Boids to look like. Additionally, I'm very inexperienced with Unity, and even worse with providing Builds to users. If a Build doesn't function, you'll have better luck loading the project and building yourself, likely.* \ No newline at end of file