Pimp My Docs
Marcin Kulik
12 years ago
parent
da53e64585
commit
333e063161
@ -1,24 +1,47 @@
|
||||
<h1>
|
||||
About
|
||||
</h1>
|
||||
|
||||
<p>No nonsense asciicasting for serious hackers</p>
|
||||
|
||||
<p>
|
||||
<a href="https://twitter.com/asciiio">Follow on Twitter</a> |
|
||||
<a href="https://github.com/sickill/ascii.io">Contribute on Github</a> |
|
||||
<a href="https://twitter.com/sickill">Meet the authors</a>
|
||||
</p>
|
||||
|
||||
<h2>What?</h2>
|
||||
|
||||
<p>
|
||||
<strong>ascii.io</strong> lets you record your terminal sessions and share
|
||||
them with other geeks simply by running <code>asciiio</code> command in your term.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
It is fully open-source platform with aim of being a "go to" place for terminal users
|
||||
wanting to share their hackery. Web based player is an implementation of VT100/VT102
|
||||
ANSI terminal, supporting most ANSI sequences, all text attributes and 256 colors.
|
||||
</p>
|
||||
<%= markdown do %>
|
||||
|
||||
# About
|
||||
|
||||
ASCII.IO is the simplest way to record your terminal and share the recordings
|
||||
with your fellow geeks.
|
||||
|
||||
It's a free service built with open-source technologies (check the
|
||||
[source](https://github.com/sickill/ascii.io)
|
||||
[code](https://github.com/sickill/ascii.io-cli)) aiming to be a "go to" place
|
||||
for everyone who want to share his terminal Voodoo.
|
||||
|
||||
## Parts
|
||||
|
||||
The service consists of two parts:
|
||||
|
||||
* Terminal recording utility
|
||||
* This site with web based player
|
||||
|
||||
Terminal recorder is a [Python
|
||||
script](https://github.com/sickill/ascii.io-cli/blob/master/bin/asciiio.py)
|
||||
that acts as a middleman
|
||||
([pseudo-terminal](http://en.wikipedia.org/wiki/Pseudo_terminal) specifically)
|
||||
between your shell and your terminal, recording all terminal activity and
|
||||
uploading it to [ascii.io](http://ascii.io) site.
|
||||
|
||||
Web based player is a JavaScript implementation of
|
||||
[VT102 ANSI terminal](http://en.wikipedia.org/wiki/VT102), supporting most ANSI
|
||||
control codes and sequences, all text attributes and
|
||||
[256 colors](<%= asciicast_path(CFG['COLOR_CHECK_CAST_ID']) %>).
|
||||
|
||||
## Authors
|
||||
|
||||
ASCII.IO was created by [Marcin Kulik](/~sickill) with the help of
|
||||
[Michał Wróbel](https://github.com/sparrovv).
|
||||
|
||||
## Getting in touch
|
||||
|
||||
[twitter.com/asciiio](https://twitter.com/asciiio) |
|
||||
[twitter.com/sickill](https://twitter.com/asciiio)
|
||||
|
||||
## Contributing
|
||||
|
||||
[Source code](https://github.com/sickill/ascii.io) |
|
||||
[Issues](https://github.com/sickill/ascii.io/issues)
|
||||
|
||||
<% end -%>
|
||||
|
||||
@ -1,7 +1,5 @@
|
||||
<h1>
|
||||
F.A.Q
|
||||
</h1>
|
||||
<%= markdown do %>
|
||||
|
||||
<p>
|
||||
TODO
|
||||
</p>
|
||||
# F.A.Q
|
||||
|
||||
<% end -%>
|
||||
|
||||
@ -1,7 +1,21 @@
|
||||
<h1>
|
||||
Options
|
||||
</h1>
|
||||
<%= markdown do %>
|
||||
|
||||
<p>
|
||||
TODO
|
||||
</p>
|
||||
# Recorder options
|
||||
|
||||
$ asciiio -h
|
||||
usage: asciiio.py [-h] [-i] [-c <command>] [-t <title>] [action]
|
||||
|
||||
Asciicast recorder+uploader.
|
||||
|
||||
Actions:
|
||||
rec record asciicast (this is the default when no action given)
|
||||
upload upload recorded (but not uploaded) asciicasts
|
||||
auth authenticate and/or claim recorded asciicasts
|
||||
|
||||
Optional arguments:
|
||||
-c command run specified command instead of shell ($SHELL)
|
||||
-t title specify title of recorded asciicast
|
||||
-h, --help show this help message and exit
|
||||
--version show version information
|
||||
|
||||
<% end -%>
|
||||
|
||||
@ -1,22 +1,45 @@
|
||||
<h1>Record!</h1>
|
||||
|
||||
<%= markdown do %>
|
||||
To install or upgrade **ascii.io** recorder, open a terminal and run following command:
|
||||
|
||||
$ curl -sL get.ascii.io | bash
|
||||
# Getting started
|
||||
|
||||
(when using zsh you may need to run `rehash` after above command)
|
||||
## Install recorder script
|
||||
|
||||
That's it! Now you can start recording your terminal sessions with:
|
||||
To install or upgrade ascii.io recorder, open a terminal and run following
|
||||
command:
|
||||
|
||||
$ asciiio
|
||||
$ curl -sL get.ascii.io | bash
|
||||
|
||||
If you want your recordings to be assigned to your ascii.io profile (btw, see mine: [~sickill](/~sickill)) run this
|
||||
That's it! Now you can start recording your terminal sessions.
|
||||
|
||||
## Create profile (optional)
|
||||
|
||||
If you want your recordings to be assigned to your ascii.io profile run this
|
||||
and follow instructions:
|
||||
|
||||
$ asciiio auth
|
||||
|
||||
See available commands and options 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.
|
||||
|
||||
Btw, see [my profile](/~sickill).
|
||||
|
||||
## 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`
|
||||
command or just hit `<C-d>`.
|
||||
|
||||
## 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
|
||||
|
||||
<% end %>
|
||||
|
||||
Loading…
Reference in New Issue