Port latest installation doc changes to eex

This commit is contained in:
Marcin Kulik 2017-05-12 20:05:51 +02:00
parent 045a26da1f
commit e6cbd117bc
2 changed files with 82 additions and 35 deletions

View File

@ -1,13 +1,34 @@
# Installation
## Python package
There are several ways to get asciinema recorder:
- [Installing via Pip](#installing-via-pip)
- [Installing on Linux](#installing-on-linux)
- [Installing on Linux as snap](#installing-on-linux-as-snap) (universal Linux package)
- [Installing on macOS](#installing-on-macos)
- [Installing on FreeBSD](#installing-on-freebsd)
- [Installing on OpenBSD](#installing-on-openbsd)
- [Running in Docker container](#running-in-docker-container)
- [Running from source](#running-from-source)
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. We have [Github
issue](https://github.com/asciinema/asciinema/issues/116) where we track new
releases and packaging progress.
## Installing via Pip
{: #installing-via-pip}
asciinema is available on [PyPI](https://pypi.python.org/pypi/asciinema) and can
be installed with pip (Python 3 required):
sudo pip3 install asciinema
## Native packages
This is the universal installation method for all operating systems, which
always provides the latest version.
## Installing on Linux
{: #installing-on-linux}
### Arch Linux
@ -27,41 +48,17 @@ For Fedora >= 22:
sudo dnf install asciinema
### FreeBSD
Ports:
cd /usr/ports/textproc/asciinema && make install
Packages:
pkg install asciinema
### Gentoo Linux
emerge -av asciinema
### NixOS / Nix
nix-env -i go1.4-asciinema
nix-env -i asciinema
### OpenBSD
### openSUSE
pkg_add asciinema
### OS X
Homebrew:
brew update && brew install asciinema
MacPorts:
sudo port selfupdate && sudo port install asciinema
Nix:
nix-env -i go1.4-asciinema
zypper in asciinema
### Ubuntu
@ -69,15 +66,65 @@ Nix:
sudo apt-get update
sudo apt-get install asciinema
### No package for your operating system?
## Installing on Linux as snap
{: #installing-on-linux-as-snap}
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.
Install asciinema in seconds on [Ubuntu and other snap supported Linux distributions](https://snapcraft.io/docs/core/install) with:
## Running latest version from master
snap install asciinema --classic
Installing a snap is very quick. Snaps contain all necessary dependencies required to run. The snap will get automatically updated when a new version is pushed to the store.
## Installing on macOS
{: #installing-on-macos}
### Homebrew
brew install asciinema
### MacPorts
sudo port selfupdate && sudo port install asciinema
### Nix
nix-env -i asciinema
## Installing on FreeBSD
{: #installing-on-freebsd}
### Ports
cd /usr/ports/textproc/asciinema && make install
### Packages
pkg install asciinema
## Installing on OpenBSD
{: #installing-on-openbsd}
pkg_add asciinema
## Running in Docker container
{: #running-in-docker-container}
asciinema Docker image is based on Ubuntu 16.04 and has the latest version of
asciinema recorder pre-installed.
docker pull asciinema/asciinema
When running it don't forget to allocate a pseudo-TTY (`-t`), keep STDIN open
(`-i`) and mount config directory volume (`-v`):
docker run --rm -ti -v "$HOME/.config/asciinema":/root/.config/asciinema asciinema/asciinema
## Running from source
{: #running-from-source}
If none of the above works for you (or you want to help with development) just
clone the repo and run asciinema straight from the checkout:
clone the repo and run latest version of asciinema straight from the master
branch:
git clone https://github.com/asciinema/asciinema.git
cd asciinema

View File

@ -2,7 +2,7 @@
Install asciinema with:
</p>
<pre><code>brew update && brew install asciinema</code></pre>
<pre><code>brew install asciinema</code></pre>
<p>
See other <a href="<%= doc_path(@conn, :show, :installation) %>">installation options</a>.