Texinfo documentation, website and asciicasts

[paster.git] / doc / asciicast.texi

diff --git a/doc/asciicast.texi b/doc/asciicast.texi
new file mode 100644 (file)
index 0000000..2dc6be2
--- /dev/null
+++ b/doc/asciicast.texi
@@ -0,0 +1,22 @@
+@node Asciicast
+@unnumbered Asciicast
+
+You can optionally automatically generate HTML pages for your
+@file{.cast}s, if you copy
+@url{https://github.com/asciinema/asciinema-player/releases, asciinema-player}
+bundle to your HTTP server and specify its base name for
+@option{-asciicast-path}:
+
+@example
+$ v=v2.6.1
+$ u=https://github.com/asciinema/asciinema-player/releases/download/$v/
+$ for ext in css js ; do
+    wget -O /path/to/www/asciinema-player-$v.$ext $u/asciinema-player.$ext
+done
+
+use $GOPATH/bin/paster -asciicast-path asciinema-player-v2.6.1
+@end example
+
+After that, additional @file{.cast.html} file will be generated during
+upload each time, with the links to the @file{.cast} and the player. You
+will also get those HTML URLs in the output.