From add345dc506481614ce1d8fe1276a61eea8bf1c0 Mon Sep 17 00:00:00 2001 From: Saroj Date: Tue, 5 Nov 2019 20:15:00 +0530 Subject: [PATCH] add the content of text files into a single readme.md file --- AUTHORS | 4 --- CONTRIBUTING | 11 --------- README | 37 ---------------------------- README.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 69 insertions(+), 52 deletions(-) delete mode 100644 AUTHORS delete mode 100644 CONTRIBUTING delete mode 100644 README create mode 100644 README.md diff --git a/AUTHORS b/AUTHORS deleted file mode 100644 index 3872ee80..00000000 --- a/AUTHORS +++ /dev/null @@ -1,4 +0,0 @@ -Dustin Kirkland -Nick Barcet -Raphaël Pinson -Derek Carter diff --git a/CONTRIBUTING b/CONTRIBUTING deleted file mode 100644 index 63c3d5ea..00000000 --- a/CONTRIBUTING +++ /dev/null @@ -1,11 +0,0 @@ -You may contribute to Byobu by branching the source from Launchpad (ideally), or by forking the project on Github (less ideally): - -$ bzr branch lp:byobu - -$ git clone git://github.com/dustinkirkland/byobu.git - -You commit changes locally, and then propose a merge in Launchpad (ideally), or submit a pull request on Github (less ideally). - -As for coding standards, please use tabs, rather than spaces. Thanks! - -:-Dustin diff --git a/README b/README deleted file mode 100644 index 13a14513..00000000 --- a/README +++ /dev/null @@ -1,37 +0,0 @@ -For more information about this package, please see: - * http://byobu.org - -If Byobu is not packaged for your Linux or UNIX OS, or if you do not have -administrative privileges in order to install Byobu, you may be able to -install locally, using the following instructions... - - 0) If you pull the source from the upstream bzr or git: - bzr branch lp:byobu && cd byobu - git clone git://github.com/dustinkirkland/byobu.git byobu-src && cd byobu-src - ./debian/rules autoconf - 1) Or download the latest officially released version from: - https://launchpad.net/byobu/+download - 2) Extract: - tar zxvf byobu*.tar.gz && cd byobu* - 3) Configure: - ./configure --prefix="$HOME/byobu" - 4) OPTIONAL: Use python from your environment, rather than from your distro - echo "export BYOBU_PYTHON='/usr/bin/env python'" >> $HOME/.bashrc - 5) Build: - make - 6) Install: - make install - 7) Update your PATH and BYOBU_PREFIX environment variables - echo "export PATH=$HOME/byobu/bin:$PATH" >> $HOME/.bashrc - . $HOME/.bashrc - 8) Run: - byobu - -Note that you will need to have a few dependencies installed: - * tmux >= 1.5 and screen - * python-newt (if you want to use Byobu's configuration utility) - * gsed (if your sed implementation doesn't support -i) - * coreutils - -Dustin Kirkland -2015-03-01 diff --git a/README.md b/README.md new file mode 100644 index 00000000..0c82241d --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +Byobu is a GPLv3 open source text-based window manager and terminal multiplexer. It was originally designed to provide elegant enhancements to the otherwise functional, plain, practical GNU Screen, for the Ubuntu server distribution. Byobu now includes an enhanced profiles, convenient keybindings, configuration utilities, and toggle-able system status notifications for both the GNU Screen window manager and the more modern Tmux terminal multiplexer, and works on most Linux, BSD, and Mac distributions. + +For more information about this package, please visit: + http://byobu.org + +If *Byobu* is not packaged for your Linux or UNIX OS, or if you do not have +administrative privileges in order to install Byobu, you may be able to +install locally, using the following instructions... + + 1. If you pull the source from the upstream bzr or git: + ` bzr branch lp:byobu && cd byobu` + `git clone git://github.com/dustinkirkland/byobu.git byobu-src` + `cd byobu-src ./debian/rules autoconf` + 2. Or download the latest officially released version from: + https://launchpad.net/byobu/+download + 3. Extract: + ` tar zxvf byobu*.tar.gz && cd byobu*` + 4. Configure: + `./configure --prefix="$HOME/byobu"` + + ***OPTIONAL*** : You may use python from your environment, rather than from your disto + `echo "export BYOBU_PYTHON='/usr/bin/env python'" >> $HOME/.bashrc` + + 5. Build: + `make` + 6. Install: + `make install` + 7. Update your PATH and BYOBU_PREFIX environment variables + `echo "export PATH=$HOME/byobu/bin:$PATH" >> $HOME/.bashrc + . $HOME/.bashrc` + 8. Run: + `byobu` + +> Note that you will need to have a few dependencies installed: + * tmux >= 1.5 and screen + * python-newt (if you want to use Byobu's configuration utility) + * gsed (if your sed implementation doesn't support -i) + * coreutils + + +### CONTRIBUTION + +You may contribute to Byobu by branching the source from Launchpad (ideally), or by forking the project on Github (less ideally): + +$ bzr branch lp:byobu + +$ git clone git://github.com/dustinkirkland/byobu.git + +You commit changes locally, and then propose a merge in Launchpad (ideally), or submit a pull request on Github (less ideally). + +As for coding standards, please use tabs, rather than spaces. Thanks! + + + +### AUTHORS +Dustin Kirkland + +Nick Barcet + +Raphaël Pinson + +Derek Carter + +### LICENSE: +https://github.com/dustinkirkland/byobu/blob/master/COPYING + +Dustin Kirkland + +2015-03-01