summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorNicholas Marriott <nicholas.marriott@gmail.com>2019-05-11 07:55:28 +0100
committerNicholas Marriott <nicholas.marriott@gmail.com>2019-05-11 07:55:28 +0100
commit0d64531f66309f013c1718d86ee907a058eca134 (patch)
tree08fe4f78bc43be68df01bda67bcab80fa808c3ba /README
parentf44dafd224ee583d1ffd4358423d78a2bae75d5a (diff)
Tweaks to README, some from me, some from Nicolas CARPi.
Diffstat (limited to 'README')
-rw-r--r--README52
1 files changed, 29 insertions, 23 deletions
diff --git a/README b/README
index 010111b6..ecae0de7 100644
--- a/README
+++ b/README
@@ -6,13 +6,17 @@ screen and continue running in the background, then later reattached.
This release runs on OpenBSD, FreeBSD, NetBSD, Linux, OS X and Solaris.
-tmux depends on libevent 2.x. Download it from:
+* Dependencies
- http://libevent.org
+tmux depends on libevent 2.x, available from:
+
+ https://github.com/libevent/libevent/releases/latest
It also depends on ncurses, available from:
- http://invisible-island.net/ncurses/
+ https://invisible-mirror.net/archives/ncurses/
+
+* Installation
To build and install tmux from a release tarball, use:
@@ -32,40 +36,42 @@ To get and build the latest from version control:
(Note that this requires at least a working C compiler, make, autoconf,
automake, pkg-config as well as libevent and ncurses libraries and headers.)
-For more information see http://git-scm.com. Patches should be sent by email to
-the mailing list at tmux-users@googlegroups.com or submitted through GitHub at
-https://github.com/tmux/tmux/issues.
+* Contributing
+
+Bug reports, feature suggestions and especially code contributions are most
+welcome. Please send by email to:
+
+ tmux-users@googlegroups.com
+
+Or open a GitHub issue or pull request.
-For documentation on using tmux, see the tmux.1 manpage. It can be viewed from
-the source tree with:
+* Documentation
+
+For documentation on using tmux, see the tmux.1 manpage. View it from the
+source tree with:
$ nroff -mdoc tmux.1|less
-A small example configuration in example_tmux.conf.
+A small example configuration is in example_tmux.conf.
-And a bash(1) completion file at:
+A bash(1) completion file is at:
https://github.com/imomaliev/tmux-bash-completion
-For debugging, running tmux with -v or -vv will generate server and client log
-files in the current directory.
-
-tmux mailing lists are available. For general discussion and bug reports:
+For debugging, run tmux with -v and -vv to generate server and client log files
+in the current directory.
- https://groups.google.com/forum/#!forum/tmux-users
+* Support
-And for Git commit emails:
+The tmux mailing list for general discussion and bug reports is:
- https://groups.google.com/forum/#!forum/tmux-git
+ https://groups.google.com/forum/#!forum/tmux-users
-Subscribe by sending an email to <tmux-users+subscribe@googlegroups.com>.
+Subscribe by sending an email to:
-Bug reports, feature suggestions and especially code contributions are most
-welcome. Please send by email to:
+ tmux-users+subscribe@googlegroups.com
- tmux-users@googlegroups.com
+* License
This file and the CHANGES, FAQ, SYNCING and TODO files are licensed under the
ISC license. All other files have a license and copyright notice at their start.
-
--- Nicholas Marriott <nicholas.marriott@gmail.com>