From 53c4d93f425b1b68a81f342ee66cfd02d328a0ea Mon Sep 17 00:00:00 2001
From: Steven Silvester <steven.silvester@ieee.org>
Date: Tue, 7 Oct 2014 07:56:19 -0500
Subject: [PATCH] Add notes about Travis usage

---
 .travis.yml          |  2 ++
 doc/travis_notes.txt | 20 ++++++++++++++++++++
 2 files changed, 22 insertions(+)
 create mode 100644 doc/travis_notes.txt

diff --git a/.travis.yml b/.travis.yml
index 26d487de..ab2aaf53 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -3,6 +3,8 @@
 # After changing this file, check it on:
 #   http://lint.travis-ci.org/
 
+# See docs/travis_notes.txt for some guidelines
+
 language: python
 
 python:
diff --git a/doc/travis_notes.txt b/doc/travis_notes.txt
new file mode 100644
index 00000000..41118669
--- /dev/null
+++ b/doc/travis_notes.txt
@@ -0,0 +1,20 @@
+
+
+Travis Notes:
+
+- Use http://lint.travis-ci.org/ to make sure it is valid yaml.
+- Make sure all of your "-" lines start on the same column
+- Make sure all of your "if" lines are aligned with the "else" and "fi" lines
+- "If" blocks must be on one travis statement and have semicolons at the end of each line:
+
+```
+    - if [[ $TRAVIS_PYTHON_VERSION == 2.7 ]]; then
+        echo "2.7";
+      else
+        echo "Not 2.7";
+      end
+```
+
+- "If" blocks cannot contain comments
+- Use `travis_retry` before a command to have it try several times before failing
+  (useful for installing from third party sources)