diff --git a/README.md b/README.md new file mode 100644 index 0000000..409765a --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# swarmc + +A [Particle Swarm +Optimisation](https://en.wikipedia.org/wiki/Particle_swarm_optimization) +visualiser in C++. Run with `swarm ` 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