From c0987102e7ff86a7f829e3a74e930e47db89f47f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Peter=20Babi=C4=8D?= Date: Sun, 26 Apr 2015 22:43:16 +0200 Subject: [PATCH] readme update --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 40b5a06..1ffd14c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ # Description `robocode-svm` is a script to demonstrate Support Vector Machine (SVM) classification on outcomes of the battles of Robocode. + +# Installation +The script runs under Linux and requires `robocode`, `svm-scale`, `svm-train` and `svm-predict` executables located in the `PATH`. On Arch Linux (or it's derivative, like i.e. Manjaro), this can be achieved by installing [libsvm](https://aur.archlinux.org/packages/libsvm/) and [robocode](https://aur.archlinux.org/packages/robocode/) from AUR (if enabled) by following command (or equivalent) +``` +yaourt -S robocode libsvm +``` + +# Usage +Generate the data required for SVM classification and show the accuracy +of the generated SVM model. If coordinates are supported, one visual battle +is shown to support the prediction. + +USAGE: robocode-svm ACTION +USAGE: robocode-svm --battle x y [alpha] + + --battle Shows visual run of the specified battle + -g,--generate Just generate the battle data + -a,--accuracy Show the accuracy of the SVM model, + -c,--clean Delete all the battle data! + -h,--help Show this help +