Update installation instructions

This commit is contained in:
Marcin Kulik 2014-12-16 20:20:47 +00:00
parent 03f9d1b1d3
commit 8dc6db023e
8 changed files with 61 additions and 46 deletions

View File

@ -22,4 +22,6 @@ $(function() {
e.preventDefault();
$('.embed-box').slideDown('fast');
});
$('[data-toggle="popover"]').popover({ html: true });
});

View File

@ -25,6 +25,11 @@
h1, h2
text-shadow: black 3px 3px 5px
.popover
color: #333
max-width: 1000px
width: 480px
.features
h1
margin: 0 0 20px 0

View File

@ -18,6 +18,10 @@ class HomePagePresenter
Asciicast.random_featured_limited(6).decorate
end
def install_script_url
"https://asciinema.org/install"
end
private
def get_asciicast

View File

@ -0,0 +1 @@
<p>On Linux and Mac OS X, <strong>the easiest way to install asciinema</strong> recorder is to run the following shell command:</p><pre>curl https://asciinema.org/install | sh</pre><p><a href='https://asciinema.org/install'>This script</a> will download the latest asciinema recorder binary for your platform, and install it in your <code>$PATH</code>.</p>

View File

@ -0,0 +1,2 @@
<%= render partial: 'docs/script_install' %>
<p>Other installation options, including distro specific packages (Ubuntu, Fedora, Arch Linux, Gentoo), are <a href='<%= docs_path(:installation) %>'>also available</a>.</p>

View File

@ -1,19 +1,12 @@
- content_for(:title, 'Getting started')
h1 Getting started
h2 1. Install the recorder
= render partial: 'docs/script_install_and_other'
markdown:
# Getting started
## 1. Install the recorder
The latest stable version of asciinema can always be installed or updated
to via [pip](http://www.pip-installer.org/en/latest/index.html):
sudo pip install --upgrade asciinema
See [installation docs](#{docs_path(:installation)}) for more installation
methods (Ubuntu, Fedora, Arch Linux, Gentoo).
## 2. Record
Go to your terminal and run the following command:
@ -31,8 +24,8 @@ markdown:
$ asciinema auth
If you skip this step now, you can always run the above command later and all
previously recorded asciicasts will automatically get assigned to your new
If you skip this step now, you can run the above command later and all
previously recorded asciicasts will automatically get assigned to your
profile.
NOTE: To be able to edit/delete your recordings you have to assign them to

View File

@ -1,52 +1,60 @@
- content_for(:title, 'Installation')
h1 Installation
h2 The easy way
= render partial: 'docs/script_install'
markdown:
# Installation
## Manual download
The latest stable version of asciinema recorder can always be found at
[pypi.python.org/pypi/asciinema](https://pypi.python.org/pypi/asciinema).
You can install or update it via
[pip](http://www.pip-installer.org/en/latest/index.html):
You can
[download the latest binary](https://github.com/asciinema/asciinema-cli/releases)
for your platform and place it in your `$PATH`.
sudo pip install asciinema
## Using package manager
If you don't have `pip`, first install it with `easy_install`:
You can also use your favorite package manager to install asciinema recorder.
Note that it takes time for native packages to be updated so you may not get
the latest released version.
sudo easy_install pip
sudo pip install asciinema
## Ubuntu
To install native Ubuntu package of asciinema recorder add [zanchey
ppa](https://launchpad.net/~zanchey/+archive/asciinema) to your software
sources list:
sudo apt-add-repository ppa:zanchey/asciinema
sudo apt-get update
sudo apt-get install asciinema
## Fedora
asciinema rpm package is included in the main Fedora 19 and 20 repository:
sudo yum install asciinema
## Arch Linux
### Arch Linux
Arch Linux users can install the
[AUR package](https://aur.archlinux.org/packages/asciinema/):
sudo yaourt -S asciinema
## Gentoo Linux
### Fedora
asciinema rpm package is included in the main Fedora 19 and 20 repository:
sudo yum install asciinema
### Gentoo Linux
Gentoo Linux users can install the
[portage package](http://packages.gentoo.org/package/app-misc/asciinema):
sudo emerge asciinema
## No native package for your operating system?
### Ubuntu
If you use some other operating system and you know how to build a native
package for it then don't hesitate, build one and let us know.
To install Ubuntu package add
[zanchey ppa](https://launchpad.net/~zanchey/+archive/asciinema) to your
software sources list:
sudo apt-add-repository ppa:zanchey/asciinema
sudo apt-get update
sudo apt-get install asciinema
### No package for your operating system?
If you use other operating system and you know how to build a native package
for it then don't hesitate, build one and let us know.
## From source
For instructions on building asciinema from source please refer to the
[README file](https://github.com/asciinema/asciinema-cli/blob/master/README.md).

View File

@ -11,7 +11,7 @@
p
' &nbsp;
p
= link_to 'Start Recording', docs_path('getting-started'), class: 'btn btn-success'
button type="button" class="btn btn-success" data-toggle="popover" data-content="#{render partial: 'docs/script_install_and_other'}<p>Once installed start recording with:</p><pre>asciinema rec</pre>" Start Recording
p
' Supports Linux and Mac OS X