From a63dbf7812e13566d4421a5b5e2870cb538434f2 Mon Sep 17 00:00:00 2001 From: Keegan McAllister Date: Mon, 5 Mar 2012 17:42:28 -0800 Subject: [PATCH] Add a README section on getting/building Mosh --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/README.md b/README.md index e8fda7b79..d02d8fa3d 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,45 @@ Other features users. Mosh does not contain any privileged (root) code. +Getting Mosh +------------ + + Mosh is available from an [Ubuntu PPA][]. Packages for other operating + systems are planned. + + [Ubuntu PPA]: https://launchpad.net/~keithw/+archive/mosh + + + On a UNIX-like system you can build Mosh from source using the following + commands: + + ./autogen.sh + ./configure + make + make install # as root + + `configure` accepts standard options, like `--prefix` to set the installation + prefix. Pass `--help` for a full listing. + + To build and use Mosh you will need + + * [GNU Autotools][] + * the [Protocol Buffers][] library and compiler + * [Boost][] + * `libutempter` + * `zlib` + * the Perl module [IO::Pty][] + + including development packages where applicable. + + The file `debian/control` contains a list of the relevant Debian packages. + + [GNU Autotools]: http://www.gnu.org/software/autoconf/ + [Protocol Buffers]: http://code.google.com/p/protobuf/ + [Boost]: http://www.boost.org/ + [IO::Pty]: http://search.cpan.org/~toddr/IO-Tty/Pty.pm + + Usage -----