From 774d678dfe4fbf31bc6544f0dab2399695d478b3 Mon Sep 17 00:00:00 2001 From: Thomas Graf Date: Sun, 24 Aug 2014 15:30:16 +0200 Subject: Convert README to markdown Signed-off-by: Thomas Graf --- README.adoc | 46 ---------------------------------------------- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 46 deletions(-) delete mode 100644 README.adoc create mode 100644 README.md diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 7323b16..0000000 --- a/README.adoc +++ /dev/null @@ -1,46 +0,0 @@ -= bmon = -:license: https://github.com/tgraf/bmon/blob/master/LICENSE - -[![Build Status](https://travis-ci.org/tgraf/bmon.svg?branch=master)](https://travis-ci.org/tgraf/bmon) - -bmon is a monitoring and debugging tool to capture networking related -statistics and prepare them visually in a human friendly way. It -features various output methods including an interactive curses user -interface and a programmable text output for scripting. - -== New in 3.4 - * Bugfixes - * blank screen with config file - * quick-help toggle with '?' in curses - * Better bmon.conf example - -== New in 3.3 - * MacOS X port - * Only initialize curses module if actually used - * Assorted bug and spelling fixes - * Various build fixes - -== Usage - -To run bmon in the default curses mode: - - bmon - -There are many other options available and full help is -provided via: - - bmon --help - -== Screenshots - -image:https://github.com/tgraf/bmon/raw/gh-pages/images/shot1.png[ -"Screenshot 1", width=512] -image:https://github.com/tgraf/bmon/raw/gh-pages/images/shot2.png[ -"Screenshot 2", width=512] - -== Copyright - - Copyright (c) 2001-2014 Thomas Graf - Copyright (c) 2013 Red Hat, Inc. - -Please see the {license}[LICENSE] file for details. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cdd67ec --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# bmon - Bandwidth Monitor + +[![Build Status](https://travis-ci.org/tgraf/bmon.svg?branch=master)](https://travis-ci.org/tgraf/bmon) + +bmon is a monitoring and debugging tool to capture networking related +statistics and prepare them visually in a human friendly way. It +features various output methods including an interactive curses user +interface and a programmable text output for scripting. + +## Changes + +### New in 3.4 + * Bugfixes + * blank screen with config file + * quick-help toggle with '?' in curses + * Better bmon.conf example + +## New in 3.3 + * MacOS X port + * Only initialize curses module if actually used + * Assorted bug and spelling fixes + * Various build fixes + +### Usage + +To run bmon in the default curses mode: + +> bmon + +There are many other options available and full help is +provided via: + +> bmon --help + +## Screenshots + +![Screenshot 1](https://github.com/tgraf/bmon/raw/gh-pages/images/shot1.png =512x) +![Screenshot 2](https://github.com/tgraf/bmon/raw/gh-pages/images/shot2.png =512x) + +## Copyright + +> *Copyright (c) 2001-2014 Thomas Graf +> Copyright (c) 2013 Red Hat, Inc.* + +Please see the [LICENSE](https://github.com/tgraf/bmon/blob/master/LICENSE) +file for additional details. + -- cgit v1.2.3