Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 87 lines (50 sloc) 2.396 kB
888215b @antono link to ebuild
antono authored
1 # Shelr -- [tool for terminal screencasting][TV].
6a4a600 @antono Initial commit to shellcast.
antono authored
2
a3f8ac3 @antono Travis ci build status button
antono authored
3 [![Build Status](https://secure.travis-ci.org/antono/shelr.png?branch=master)](http://travis-ci.org/antono/shelr)
4
888215b @antono link to ebuild
antono authored
5 `shelr` allows you to record/replay and publish your terminal on [http://shelr.tv](http://shelr.tv).
0b48a4e @antono Canonical location of repo is http://github.com/shelr/shelr
antono authored
6 [Code for Shelr.tv](https://github.com/shelr/shelr.tv) service is also available on github.
888215b @antono link to ebuild
antono authored
7
8
f5e69db @antono README
antono authored
9 ## Installation
10
29b6334 @antono installation instructions for debian and arch
antono authored
11 ### From gem
12
f011f9a @antono Updated docs in README.md
antono authored
13 You'll need ruby and rubygems installed.
14
9971783 @antono Update README.md
antono authored
15 [sudo] gem install shelr
16
0b48a4e @antono Canonical location of repo is http://github.com/shelr/shelr
antono authored
17 On ubuntu older than precise or debian older than wheezy you should also add following to your `.bashrc` or `.zshrc`
9971783 @antono Update README.md
antono authored
18
19 export PATH=/var/lib/gems/1.8/bin:$PATH
f011f9a @antono Updated docs in README.md
antono authored
20
cf90ece @antono README update
antono authored
21 Watch [asciicast](http://shelr.tv/records/4f49ea4ae557800001000004) for details :)
f011f9a @antono Updated docs in README.md
antono authored
22
29b6334 @antono installation instructions for debian and arch
antono authored
23 ### From packages
24
0b48a4e @antono Canonical location of repo is http://github.com/shelr/shelr
antono authored
25 - [PPA](https://launchpad.net/~antono/+archive/shelr) for Ubuntu
2c48399 @antono Updated docs and gemspecs
antono authored
26 - [PKGBUILD](https://aur.archlinux.org/packages.php?ID=56945) for Arch Linux
888215b @antono link to ebuild
antono authored
27 - [EBUILD](http://overlays.gentoo.org/proj/sunrise/browser/app-misc/shelr) for Gentoo Linux
0b48a4e @antono Canonical location of repo is http://github.com/shelr/shelr
antono authored
28 - [deb](http://mentors.debian.net/package/shelr) for Debian (Mentor Wanted)
29b6334 @antono installation instructions for debian and arch
antono authored
29
cf90ece @antono README update
antono authored
30 ## Watching other's records in your terminal
f011f9a @antono Updated docs in README.md
antono authored
31
46fad17 @antono README.md updated
antono authored
32 shelr play http://shelr.tv/records/4f4ca2a43cd1090001000002.json
f5e69db @antono README
antono authored
33
f011f9a @antono Updated docs in README.md
antono authored
34 You can watch them online at [http://shelr.tv/][TV]
6a4a600 @antono Initial commit to shellcast.
antono authored
35
cf90ece @antono README update
antono authored
36 ## Recording your terminal
f011f9a @antono Updated docs in README.md
antono authored
37
38 shelr record
39
cf90ece @antono README update
antono authored
40 Recording started. Do what you whant to record...
41 To finish recording type 'exit' or just Ctrl+D.
42
43 ## Publishing your record
44
45 shelr push last
46
47 When you have some asciicasts at your machine you can pick one:
f011f9a @antono Updated docs in README.md
antono authored
48
49 shelr list
50 <select id of your record>
51 shelr push <ID>
6a4a600 @antono Initial commit to shellcast.
antono authored
52
cf90ece @antono README update
antono authored
53 There is alias for last record:
54
55 If you want private record, provide --private switch:
56
57 shelr push last --private
58
59 Such record will be accessible by secret URL with access_key.
60
b7fe4e8 @antono README updated
antono authored
61 ## Dependencies
6a4a600 @antono Initial commit to shellcast.
antono authored
62
cf90ece @antono README update
antono authored
63 ### Linux/Hurd
64
65 You need `script` tool from linux-utils.
66 It's already installed if You use Linux.
67 Note that old school BSD `script` will not work.
46fad17 @antono README.md updated
antono authored
68
cf90ece @antono README update
antono authored
69 ### BSD/OSX
46fad17 @antono README.md updated
antono authored
70
cf90ece @antono README update
antono authored
71 Unfortunally BSD and OSX ship old `script` wich lack timing support.
72 If You use this systems - install `ttyrec` via ports macprots or homebrew
73 and setup it as recording backend.
46fad17 @antono README.md updated
antono authored
74
cf90ece @antono README update
antono authored
75 brew install ttyrec # OSX
76 sudo port install ttyrec # BSD / OSX
77 shelr backend ttyrec # BSD / OSX
46fad17 @antono README.md updated
antono authored
78
b7fe4e8 @antono README updated
antono authored
79 ## Copyright
80
3419ec0 @antono Э
antono authored
81 (Э) 2010, 2011, 2012 Antono Vasiljev and
0b48a4e @antono Canonical location of repo is http://github.com/shelr/shelr
antono authored
82 [contributors](https://github.com/shelr/shelr/contributors).
2c48399 @antono Updated docs and gemspecs
antono authored
83
84 See LICENSE.txt for details.
f011f9a @antono Updated docs in README.md
antono authored
85
cf90ece @antono README update
antono authored
86 [TV]: http://shelr.tv/ "Asciicasts from unix ninjas"
Something went wrong with that request. Please try again.