chore: add README

This commit is contained in:
dvdrw 2024-11-25 14:54:17 +01:00
parent 1b2ff590ec
commit 264f381306
Signed by: dvdrw
GPG Key ID: 3ED4E5A371C20DD7

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# swarmc
A [Particle Swarm
Optimisation](https://en.wikipedia.org/wiki/Particle_swarm_optimization)
visualiser in C++. Run with `swarm <iteration count>` and enjoy the pretty
colors. Pressing `h` will print out a help menu.
Requires an ANSI terminal (emulator) with support for 24-bit colours to render.
The implemented showcase works for `R^2 -> R` functions, but the underlying code
can work for much more, including for spaces other than real spaces (see the
type parameters in `Agent` et al).
Supports dynamically changing Particle parameters.
Although not implemented (yet!), the code supports arbitrary swarm topologies