Finally updated the README

This commit is contained in:
2018-07-16 10:36:47 +02:00
parent 24f9515565
commit db64e16908
2 changed files with 21 additions and 14 deletions

5
.gitignore vendored
View File

@@ -3,6 +3,11 @@
*.jpg *.jpg
*.avi *.avi
*.mpg *.mpg
*.pptx
*.mov
*.mp4
*.mkv
*~ *~
~* ~*
exp_* exp_*
.DS_Store

View File

@@ -2,7 +2,7 @@
## Prerequisites ## Prerequisites
1. (L)ubuntu 14.04 32-bit 1. (L)ubuntu 14.04
2. Git installed: 2. Git installed:
```sh ```sh
@@ -11,19 +11,21 @@ sudo apt install git -y
## How to start working ## 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 2. Check if NAOQi binding for Python works by launching Python and running there
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
`from naoqi import ALProxy`. The installation was successful if it imports `from naoqi import ALProxy`. The installation was successful if it imports
without errors. You can finish Python with `ctrl-d` then. 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.**