aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Keegan McAllister <mcallister.keegan@gmail.com>2012-03-05 17:42:28 -0800
committerGravatar Keegan McAllister <mcallister.keegan@gmail.com>2012-03-05 22:01:59 -0800
commita63dbf7812e13566d4421a5b5e2870cb538434f2 (patch)
treef12fef71ce2668901137868ffe2e78bef835071e /README.md
parent1e996a5372c84633e44736f22fd1f874e854cbcd (diff)
Add a README section on getting/building Mosh
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md
index e8fda7b..d02d8fa 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
-----