diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..a9c9f21 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# ssh-tmux + +The `ssh-tmux` utility executes a given command via `ssh` in a new `tmux` +session on a specified host. + +The intended purpose is to execute long-running interactive remote commands +with the ability to re-connect. See [this](https://www.skreutz.com/posts/TODO/) +blog post for an introduction, and refer to the man page for details. + +## Install + +Run `make install` as root to install the `ssh-tmux` utility and man page. + +## Release + +Create an annotated tag, and an archive as follows, replacing `0.1.0` with the +current version. + + $ git tag --annotate --message "Version 0.1.0" 0.1.0 + $ git archive --format=tar.gz --prefix=ssh-tmux-0.1.0/ \ + --output ssh-tmux-0.1.0.tar.gz 0.1.0 + |