From d8d27955ebf0f2901d80ad91243c7000972060c6 Mon Sep 17 00:00:00 2001 From: Marcin Kulik Date: Tue, 23 Jun 2015 23:41:07 +0200 Subject: [PATCH] Update installation docs --- app/views/docs/_script_install.html.erb | 2 +- app/views/docs/config.html.md | 4 +- app/views/docs/installation.html.md | 55 ++++++++++--------------- 3 files changed, 24 insertions(+), 37 deletions(-) diff --git a/app/views/docs/_script_install.html.erb b/app/views/docs/_script_install.html.erb index c39cd27..0463b26 100644 --- a/app/views/docs/_script_install.html.erb +++ b/app/views/docs/_script_install.html.erb @@ -1 +1 @@ -

On Linux and Mac OS X, the easiest way to install asciinema recorder is to run the following shell command:

curl -sL https://asciinema.org/install | sh

This script will download the latest asciinema recorder binary for your platform, and install it in your $PATH.

+
curl -sL https://asciinema.org/install | sh

This script will download the latest asciinema recorder binary for your platform, and install it in your $PATH.

diff --git a/app/views/docs/config.html.md b/app/views/docs/config.html.md index 8cbeeb3..725ed63 100644 --- a/app/views/docs/config.html.md +++ b/app/views/docs/config.html.md @@ -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. diff --git a/app/views/docs/installation.html.md b/app/views/docs/installation.html.md index 6bbfb51..1cda82c 100644 --- a/app/views/docs/installation.html.md +++ b/app/views/docs/installation.html.md @@ -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