Update online docs

openid
Marcin Kulik 12 years ago
parent 57e2d989c9
commit 0ff6721530

@ -27,7 +27,7 @@ h2 {
h3 {
font-size: 16px;
margin: 0;
margin: 20px 0;
}
ol, ul {
@ -234,3 +234,15 @@ ul.delimited {
abbr.timeago {
border-bottom: 0;
}
code {
}
pre {
padding: 10px;
background-color: white;
color: black;
}
pre code {
}

@ -2,8 +2,10 @@
# Recorder options
See the list of available options with:
$ asciiio -h
usage: asciiio.py [-h] [-i] [-c <command>] [-t <title>] [action]
usage: asciiio [-h] [-i] [-y] [-c <command>] [-t <title>] [action]
Asciicast recorder+uploader.
@ -15,6 +17,7 @@
Optional arguments:
-c command run specified command instead of shell ($SHELL)
-t title specify title of recorded asciicast
-y don't prompt for confirmation
-h, --help show this help message and exit
--version show version information

@ -2,44 +2,57 @@
# Getting started
## Install recorder script
## 1. Install recorder
To install or upgrade ascii.io recorder, open a terminal and run following
### Linux
To install/update ascii.io recorder, open a terminal and run following
command:
$ curl -sL get.ascii.io | bash
That's it! Now you can start recording your terminal sessions.
### OSX (via Homebrew)
## Create profile (optional)
Install with:
If you want your recordings to be assigned to your ascii.io profile run this
and follow instructions:
$ brew install https://raw.github.com/gist/3875486/asciiio.rb --HEAD
$ asciiio auth
Later update with:
If you skip this step now, you can always run above command later and all
already recorded asciicasts will get automatically assigned to your new
profile.
$ brew update asciiio
Btw, see [my profile](/~sickill).
### OSX (no Homebrew)
If you don't use Homebrew then install/update with:
## Record
$ curl -sL get.ascii.io | bash
## 2. Record
Open your terminal and run following command:
$ asciiio
New shell instance will be opened and everything you'll do in it will be
recorded. When you're ready to upload simply exit the shell with `exit`
recorded. When you're ready to upload simply exit the shell with `exit`
command or just hit `<C-d>`.
## 3. Create profile (optional)
If you want your recordings to be assigned to your ascii.io profile run this
and follow instructions:
$ asciiio auth
If you skip this step now, you can always run above command later and all
previously recorded asciicasts will get automatically assigned to your new
profile.
Btw, see [my profile](/~sickill).
## Advanced options
The recorder supports several command-line options. See
[here](<%= docs_path(:options) %>) for a list. You can always check what's
available with following command:
$ asciiio -h
[here](<%= docs_path(:options) %>) for details.
<% end %>

Loading…
Cancel
Save