From e6cbd117bca60d3a162ca3ff0ffe7ba853917e71 Mon Sep 17 00:00:00 2001 From: Marcin Kulik Date: Fri, 12 May 2017 20:05:51 +0200 Subject: [PATCH] Port latest installation doc changes to eex --- web/templates/doc/installation.html.md | 103 +++++++++++++++++------ web/templates/doc/quick_install.html.eex | 2 +- 2 files changed, 76 insertions(+), 29 deletions(-) diff --git a/web/templates/doc/installation.html.md b/web/templates/doc/installation.html.md index 9179c5c..f3b8c97 100644 --- a/web/templates/doc/installation.html.md +++ b/web/templates/doc/installation.html.md @@ -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,57 +48,83 @@ For Fedora >= 22: sudo dnf install asciinema -### FreeBSD +### Gentoo Linux -Ports: + emerge -av asciinema - cd /usr/ports/textproc/asciinema && make install +### NixOS / Nix -Packages: + nix-env -i asciinema - pkg install asciinema +### openSUSE -### Gentoo Linux + zypper in asciinema - emerge -av asciinema +### Ubuntu -### NixOS / Nix + sudo apt-add-repository ppa:zanchey/asciinema + sudo apt-get update + sudo apt-get install asciinema - nix-env -i go1.4-asciinema +## Installing on Linux as snap +{: #installing-on-linux-as-snap} -### OpenBSD +Install asciinema in seconds on [Ubuntu and other snap supported Linux distributions](https://snapcraft.io/docs/core/install) with: - pkg_add asciinema + snap install asciinema --classic -### OS X +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. -Homebrew: +## Installing on macOS +{: #installing-on-macos} - brew update && brew install asciinema +### Homebrew -MacPorts: + brew install asciinema + +### MacPorts sudo port selfupdate && sudo port install asciinema -Nix: +### Nix - nix-env -i go1.4-asciinema + nix-env -i asciinema -### Ubuntu +## Installing on FreeBSD +{: #installing-on-freebsd} - sudo apt-add-repository ppa:zanchey/asciinema - sudo apt-get update - sudo apt-get install asciinema +### 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 -### No package for your operating system? +When running it don't forget to allocate a pseudo-TTY (`-t`), keep STDIN open +(`-i`) and mount config directory volume (`-v`): -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. + docker run --rm -ti -v "$HOME/.config/asciinema":/root/.config/asciinema asciinema/asciinema -## Running latest version from master +## 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 diff --git a/web/templates/doc/quick_install.html.eex b/web/templates/doc/quick_install.html.eex index d1a9369..ffd0e3b 100644 --- a/web/templates/doc/quick_install.html.eex +++ b/web/templates/doc/quick_install.html.eex @@ -2,7 +2,7 @@ Install asciinema with:

-
brew update && brew install asciinema
+
brew install asciinema

See other installation options.