From db64e1690828b3479fbfb512d91d9dc496988664 Mon Sep 17 00:00:00 2001
From: Pavel Lutskov <pavel.lutskov@gmail.com>
Date: Mon, 16 Jul 2018 10:36:47 +0200
Subject: [PATCH] Finally updated the README

---
 .gitignore |  5 +++++
 README.md  | 30 ++++++++++++++++--------------
 2 files changed, 21 insertions(+), 14 deletions(-)

diff --git a/.gitignore b/.gitignore
index a528a28..eef75a9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,11 @@
 *.jpg
 *.avi
 *.mpg
+*.pptx
+*.mov
+*.mp4
+*.mkv
 *~
 ~*
 exp_*
+.DS_Store
diff --git a/README.md b/README.md
index 2d21d51..fe860b8 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 ## Prerequisites
 
-1. (L)ubuntu 14.04 32-bit
+1. (L)ubuntu 14.04
 2. Git installed:
 
 ```sh
@@ -11,19 +11,21 @@ sudo apt install git -y
 
 ## How to start working
 
-1. Install the software:
+1. Install the software: [instructions](
+http://doc.aldebaran.com/2-1/dev/python/install_guide.html)
 
-```sh
-cd ~/Documents
-git clone https://gitlab.lrz.de/robocupss18-blue3/kick-it.git
-cd kick-it
-setup/install_ros.sh
-setup/install_nao_ros.sh
-```
-
-2. Check if ROS is working properly by typing `roscore` and finishing it with
-`ctrl-c` if it doesn't throw errors.
-
-3. Check if NAOQi binding for Python works by launching Python and running there
+2. Check if NAOQi binding for Python works by launching Python and running there
 `from naoqi import ALProxy`. The installation was successful if it imports
 without errors. You can finish Python with `ctrl-d` then.
+
+## What's inside?
+
+* `__main__.py` - The script containing the state machine.
+* `striker.py` - The class with high lever behaviors, e.g. aligning to ball.
+* `movements.py` - Convenience classes for moving robot. Also kick is
+implemented here.
+* `finders.py` - Classes for Ball, Goal and Field detection.
+* `imagereaders.py` - Convenience classes for capturing video input from
+various sources.
+
+**More documentation as well as the detailed report will be available later.**