-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
12 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |