Skip to content

Commit

Permalink
Description improved and typo fixed.
Browse files Browse the repository at this point in the history
  • Loading branch information
BlueAndi committed Oct 5, 2023
1 parent ce0bd78 commit a414322
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Radon Ulzer - Line Follower <!-- omit in toc -->
# Radon Ulzer - Firmware for Zumo32U4 <!-- omit in toc -->

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://choosealicense.com/licenses/mit/)
[![Repo Status](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![Release](https://img.shields.io/github/release/BlueAndi/RadonUlzer.svg)](https://github.com/BlueAndi/RadonUlzer/releases)
[![Build Status](https://github.com/BlueAndi/RadonUlzer/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/BlueAndi/RadonUlzer/actions/workflows/main.yml)

A robot as fast as the famous pod racer driven by Anakin Skywalker with the powerful engines from Radon Ulzer. :-)
Several kind of applications are available:

Several kind of exclusive applications are available:
* Convoy leader - A line follower, providing information to the [DroidControlShip](https://github.com/BlueAndi/DroidControlShip) in a convoy leader role.
* Line follower - Just a line follower, using a PID controller.
* Remote Control - The robot is remote controlled by e.g. the [DroidControlShip](https://github.com/BlueAndi/DroidControlShip) in a convoy follower role.
Expand All @@ -15,11 +16,12 @@ Several kind of applications are available:

* [The robot](#the-robot)
* [The simulation](#the-simulation)
* [Intallation](#intallation)
* [Installation](#installation)
* [The Webots library](#the-webots-library)
* [Build](#build)
* [Preparation](#preparation)
* [Running the robot on track](#running-the-robot-on-track)
* [Documentation](#documentation)
* [Used Libraries](#used-libraries)
* [Issues, Ideas And Bugs](#issues-ideas-and-bugs)
* [License](#license)
Expand All @@ -39,7 +41,7 @@ The simulation is based on the open source robot simulator *Webots*. The applica
* v2023a
* v2023b

## Intallation
## Installation

1. Install [Webots](https://cyberbotics.com).
2. Setup for [external controllers](https://www.cyberbotics.com/doc/guide/running-extern-robot-controllers):
Expand Down Expand Up @@ -74,6 +76,11 @@ Platformio project tasks --> WebotsSim --> Build
1. Click in simulation on the display to focus the simulation.
2. Now the keyboard keys a, b and c can be used to control the robot according to the implemented application logic.

# Documentation

* [SW Architecture](./doc/architecture/README.md)
* [SW Configuration](./doc/configuration/README.md)

# Used Libraries

| Library | Description | License |
Expand Down

0 comments on commit a414322

Please sign in to comment.