Skip to content
Automatically exported from code.google.com/p/avalonsailing
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
buildroot
collision_port
common
etc
fakeio
go
helmsman
io2
lib
mk
modem
proto
remote_control
simulation
skipper
sms
vskipper
webui
AUTHORS
LICENSE
Makefile
README
start_avalon.sh

README

// Copyright 2011 The Avalon Project Authors. All rights reserved.
// Use of this source code is governed by the Apache License 2.0
// that can be found in the LICENSE file.

This is the root directory of the Avalon source code.

Avalon is a co-operation between The Autonomous Systems Lab of ETH
Zürich and Google Switzerland GmbH, with the intent to get a robot
sailboat to sail autonomously across the Atlantic as part of the
MicroTransat Challenge (http://www.microtransat.org/2011.php). For
more information see: http://code.google.com/p/avalonsailing/

(*) Note: Googlers can add themselves to the AUTHORS list.  ETH
students please hold off until we've written up the agreement, after
which this note will be deleted/modified.

The layout of this directory
============================
<root>
        README          this file
        AUTHORS         Authorative list of the Avalon Project Authors(*).

        mk/             The build system, see mk/README
                Makefile.*.template     copy one of these to your subsystems directory.

        doc/            Human readable documentation that for some reason isn't on the Wiki.

        planner/        Global route planning given destination, prevailing winds and currents.

        skipper/        Short term route planning, avoiding AIS objects.

        helmsman/       Maintain desired compass course given wind.
                lib/
                ...                    

        io/             Input and output to the sensors and actuators.
                sail/
                rudder/
                .../

Changelists and Code reviews
============================

This code is hosted on code.google.com, and the review process is
through Rietveld at codereview.appspot.com Try to find a reviewer from
'above' and 'below' your layer in the overall system.
 

Conventions, rules, guidelines, etc
==================================
 *  On the boat: C/C++ only, on shore (i.e. the planner): anything
 *  Try to keep the style Google conform.
 *  Two reviewers for every commit.
 *  Review for reliability as the most important attribute of the code.
 *  Dependencies must be a strict DAG.
 *  No Google-internal code.      
You can’t perform that action at this time.