Permalink
Browse files

README update

  • Loading branch information...
1 parent 94306b3 commit cf90eceb5419aa172d7e7cb2acc4563472d5ede1 @antono antono committed Apr 24, 2012
Showing with 32 additions and 17 deletions.
  1. +32 −17 README.md
View
49 README.md
@@ -18,7 +18,7 @@ On ubuntu older than precise or debian older than wheezy you should also add fol
export PATH=/var/lib/gems/1.8/bin:$PATH
-See [shellcast](http://shelr.tv/records/4f49ea4ae557800001000004) for details :)
+Watch [asciicast](http://shelr.tv/records/4f49ea4ae557800001000004) for details :)
### From packages
@@ -27,45 +27,60 @@ See [shellcast](http://shelr.tv/records/4f49ea4ae557800001000004) for details :)
- [EBUILD](http://overlays.gentoo.org/proj/sunrise/browser/app-misc/shelr) for Gentoo Linux
- [deb](http://mentors.debian.net/package/shelr) for Debian (Mentor Wanted)
-## Watching other's records
+## Watching other's records in your terminal
shelr play http://shelr.tv/records/4f4ca2a43cd1090001000002.json
You can watch them online at [http://shelr.tv/][TV]
-## Recording
+## Recording your terminal
shelr record
- ...
- do something in your shell
- ..
- exit
-## Publishing
+Recording started. Do what you whant to record...
+To finish recording type 'exit' or just Ctrl+D.
+
+## Publishing your record
+
+ shelr push last
+
+When you have some asciicasts at your machine you can pick one:
shelr list
<select id of your record>
shelr push <ID>
+There is alias for last record:
+
+If you want private record, provide --private switch:
+
+ shelr push last --private
+
+Such record will be accessible by secret URL with access_key.
+
## Dependencies
-### Linux/BSD/Hurd/etc...
+### Linux/Hurd
+
+You need `script` tool from linux-utils.
+It's already installed if You use Linux.
+Note that old school BSD `script` will not work.
-You need `script` and `scriptreplay` tools from BSD Utils.
-Tey are already installed if You use Debian/Ubuntu/BSD variants.
+### BSD/OSX
-### OSX
+Unfortunally BSD and OSX ship old `script` wich lack timing support.
+If You use this systems - install `ttyrec` via ports macprots or homebrew
+and setup it as recording backend.
-If You use OS X - install `ttyrec` via homebrew and setup it as recording backend.
+ brew install ttyrec # OSX
+ sudo port install ttyrec # BSD / OSX
+ shelr backend ttyrec # BSD / OSX
- brew install ttyrec
- shelr backend ttyrec
-
## Copyright
(Э) 2010, 2011, 2012 Antono Vasiljev and
[contributors](https://github.com/shelr/shelr/contributors).
See LICENSE.txt for details.
-[TV]: http://shelr.tv/ "Shellcasts from shell ninjas"
+[TV]: http://shelr.tv/ "Asciicasts from unix ninjas"

0 comments on commit cf90ece

Please sign in to comment.