Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
takluyver committed Sep 1, 2018
1 parent b8a135b commit 7e111de
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
This is the source repository for a guide to help people get started with
robotic sailing.

[Read the guide here](https://robotic-sailing-intro.readthedocs.io/en/latest/boat.html),
or [download a PDF](https://readthedocs.org/projects/robotic-sailing-intro/downloads/pdf/latest/).

Contributions are welcome, please open issues or pull requests in Github.
We'll try to review pull requests to ensure a consistent style.

The guide is built using Sphinx. If you clone a local copy, you can run
`make html` to check your changes. The `.rst` source files are written
in [reStructuredText](http://docutils.sourceforge.net/docs/user/rst/quickref.html).

0 comments on commit 7e111de

Please sign in to comment.