aboutsummaryrefslogtreecommitdiff
path: root/present
diff options
context:
space:
mode:
authorAudrey Lim <audreylh@gmail.com>2016-04-03 16:39:49 -0700
committerAndrew Gerrand <adg@golang.org>2016-06-01 21:14:44 +0000
commitb41cbfc0fac050e3a416b4f51df202a101cd2aa5 (patch)
tree0b406c1739b8c3743ead093da8823c7a6f3c51a6 /present
parent19c2ab042a80921dcba430d996ddfa7c0a53224c (diff)
downloadgolang-x-tools-b41cbfc0fac050e3a416b4f51df202a101cd2aa5.tar.gz
x/tools/present: add presenter notes documentation
Fixes golang/go#14654 Fixes golang/go#12355 Change-Id: I0c05db624170f7bef5883192b47b618ca343a830 Reviewed-on: https://go-review.googlesource.com/21489 Reviewed-by: Andrew Gerrand <adg@golang.org>
Diffstat (limited to 'present')
-rw-r--r--present/doc.go30
1 files changed, 30 insertions, 0 deletions
diff --git a/present/doc.go b/present/doc.go
index 351c5812c..2256f3108 100644
--- a/present/doc.go
+++ b/present/doc.go
@@ -224,5 +224,35 @@ It is your responsibilty to make sure the included HTML is valid and safe.
.html file.html
+Presenter notes:
+
+Presenter notes may be enabled by appending the "-notes" flag when you run
+your "present" binary.
+
+This will allow you to open a second window by pressing 'N' from your browser
+displaying your slides. The second window is completely synced with your main
+window, except that presenter notes are only visible on the second window.
+
+Lines that begin with ": " are treated as presenter notes.
+
+ * Title of slide
+
+ Some Text
+
+ : Presenter notes (first paragraph)
+ : Presenter notes (subsequent paragraph(s))
+
+Notes may appear anywhere within the slide text. For example:
+
+ * Title of slide
+
+ : Presenter notes (first paragraph)
+
+ Some Text
+
+ : Presenter notes (subsequent paragraph(s))
+
+This has the same result as the example above.
+
*/
package present // import "golang.org/x/tools/present"