diff options
Diffstat (limited to '.github')
-rw-r--r-- | .github/CONTRIBUTING.md | 71 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE.md | 16 | ||||
-rw-r--r-- | .github/README.md | 82 |
3 files changed, 169 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..49e2b90b --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,71 @@ +## What should I do before opening an issue? + +Before opening an issue, please ensure that: + +- `$TERM` inside tmux is screen, screen-256color, tmux or tmux-256color. Check + by running `echo $TERM` inside tmux. + +- You can reproduce the problem with the latest tmux release, or a build from + Git master. + +- Your question or issue is not covered in the manual (run man tmux). + +- Nobody else has opened the same issue recently. + +## What should I include in an issue? + +Please include the output of: + +~~~bash +uname -sp && tmux -V && echo $TERM +~~~ + +Also include: + +- Your platform (Linux, OS X, or whatever). + +- A brief description of the problem with steps to reproduce. + +- A minimal tmux config, if you can't reproduce without a config. + +- Your terminal, and `$TERM` inside and outside of tmux. + +- Logs from tmux (see below). + +- At most one or two screenshots, if helpful. + +## How do I test without a .tmux.conf? + +Run a separate tmux server with `-f/dev/null` to skip loading `.tmux.conf`: + +~~~bash +tmux -Ltest kill-server +tmux -Ltest -f/dev/null new +~~~ + +## How do I get logs from tmux? + +Add `-vv` to tmux to create three log files in the current directory. If you can +reproduce without a configuration file: + +~~~bash +tmux -Ltest kill-server +tmux -vv -Ltest -f/dev/null new +~~~ + +Or if you need your configuration: + +~~~base +tmux kill-server +tmux -vv new +~~~ + +The log files are: + +- `tmux-server*.log`: server log file. + +- `tmux-client*.log`: client log file. + +- `tmux-out*.log`: output log file. + +Please attach the log files to your issue. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..68c29530 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,16 @@ +# Issue description + +Please describe the problem and the steps to reproduce. Add a minimal tmux +config if necessary. Screenshots can be helpful, but no more than one or two. + +Please do not report bugs (crashes, incorrect behaviour) without reproducing on +a tmux built from the latest code in Git. + +# Information + +Please provide the following information: + +* tmux version (`tmux -V`). +* Platform (`uname -sp`). +* $TERM inside and outside of tmux (`echo $TERM`). +* Logs from tmux (`tmux -vv new`). diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 00000000..b586c5a2 --- /dev/null +++ b/.github/README.md @@ -0,0 +1,82 @@ +# Welcome to tmux! + +tmux is a terminal multiplexer: it enables a number of terminals to be created, +accessed, and controlled from a single screen. tmux may be detached from a +screen and continue running in the background, then later reattached. + +This release runs on OpenBSD, FreeBSD, NetBSD, Linux, OS X and Solaris. + +## Dependencies + +tmux depends on [libevent](https://libevent.org) 2.x, available from [this +page](https://github.com/libevent/libevent/releases/latest). + +It also depends on [ncurses](https://www.gnu.org/software/ncurses/), available +from [this page](https://invisible-mirror.net/archives/ncurses/). + +## Installation + +### From release tarball + +To build and install tmux from a release tarball, use: + +~~~bash +./configure && make +sudo make install +~~~ + +tmux can use the utempter library to update utmp(5), if it is installed - run +configure with `--enable-utempter` to enable this. + +### From version control + +To get and build the latest from version control: + +~~~bash +git clone https://github.com/tmux/tmux.git +cd tmux +sh autogen.sh +./configure && make +~~~ + +(Note that this requires at least a working C compiler, make, autoconf, +automake, pkg-config as well as libevent and ncurses libraries and headers.) + +## 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. + +Please read the CONTRIBUTING file before opening an issue. + +## Documentation + +For documentation on using tmux, see the tmux.1 manpage. View it from the +source tree with: + +~~~bash +nroff -mdoc tmux.1|less +~~~ + +A small example configuration is in `example_tmux.conf`. + +And a bash(1) completion file at: + +https://github.com/imomaliev/tmux-bash-completion + +For debugging, run tmux with -v or -vv to generate server and client log files +in the current directory. + +## Support + +The tmux mailing list for general discussion and bug reports is: + +https://groups.google.com/forum/#!forum/tmux-users + +Subscribe by sending an email to: + +tmux-users+subscribe@googlegroups.com |