Update installation docs

element
Marcin Kulik 9 years ago
parent cfae011508
commit d8d27955eb

@ -1 +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 -sL 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>
<pre>curl -sL 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>

@ -5,7 +5,7 @@
asciinema uses a config file to keep API token and user settings. In most cases
the location of this file is `$HOME/.config/asciinema/config`.
When you first run `asciinema`, local API token is generated and saved in the
When you first run `asciinema`, local API token is generated (UUID) and saved in the
file (unless the file already exists). It looks like this:
[api]
@ -32,7 +32,7 @@ the default one (asciinema.org), you can set `url` option. API URL can also be
passed via `ASCIINEMA_API_URL` environment variable.
The options in `[record]` and `[play]` sections have the same meaning as the
options you pass to `asciinema rec`/`asciinema play` command. If you happen to
options you pass to `asciinema rec`/`asciinema play` command (see [Usage](<%= docs_path(:usage) %>)). If you happen to
often use either `-c`, `-w` or `-y` with these commands then consider saving it
as a default in the config file.

@ -2,52 +2,30 @@
# Installation
## The easy way
<%= render partial: 'docs/script_install' %>
## Manual download
You can
[download the latest binary](https://github.com/asciinema/asciinema/releases)
for your platform and place it in your `$PATH`.
## Using package manager
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.
### OS X
On OS X asciinema is available via Homebrew:
Homebrew:
brew update
brew install asciinema
Or via MacPorts:
MacPorts:
sudo port selfupdate
sudo port install asciinema
### Arch Linux
Arch Linux users can install the
[AUR package](https://aur.archlinux.org/packages/asciinema/):
sudo yaourt -S asciinema
### 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 asciinema from
[Mauro Toffanin's overlay](https://github.com/Dr-Terrible/go-overlay):
emerge -av app-portage/layman
wget -q -O /etc/layman/overlays/go-overlay.xml https://raw.github.com/Dr-Terrible/go-overlay/master/overlay.xml
layman -Lk
@ -56,26 +34,35 @@ Gentoo Linux users can install asciinema from
### Nix / NixOS
If you're using Nix package manager then we have you covered too:
nix-env -i asciinema
### Ubuntu
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.
If you use other operating system and you can build a native package
for it then don't hesitate, do it and let us know.
## From source
For instructions on building asciinema from source please refer to the
[README file](https://github.com/asciinema/asciinema/blob/master/README.md).
If you have Go toolchain installed you can install latest (master) version with:
go get github.com/asciinema/asciinema
Refer to the
[README file](https://github.com/asciinema/asciinema/blob/master/README.md)
for detailed instructions on building from source.
## Download static binary
There are prebuilt static binaries for Mac OS X and Linux. You can
[download](https://github.com/asciinema/asciinema/releases) one
for your platform and place it in your `$PATH`.
You can use the following snippet to fetch and run our install script, which automates this:
curl -sL https://asciinema.org/install | sh

Loading…
Cancel
Save