Skip to content

Commit 6d00059

Browse files
committed
Updated README file
1 parent b804193 commit 6d00059

File tree

2 files changed

+53
-31
lines changed

2 files changed

+53
-31
lines changed

README

Lines changed: 0 additions & 31 deletions
This file was deleted.

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# CBM (Color Bandwidth Meter)
2+
3+
#### cbm - display in real time the network traffic speed
4+
5+
## Help this project ##
6+
7+
CBM needs your help. **If you are a programmer** and if you wants to help a
8+
nice project, this is your opportunity.
9+
10+
CBM was imported from some tarballs from Debian Project[1].
11+
After this, all patches found in Debian project and other places for this program
12+
were applied. All initial work was registered in ChangeLog file (version 0.2 and
13+
later releases). CBM is packaged in Debian[2] Project.
14+
15+
If you are interested to help CBM, read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
16+
17+
[1]: http://snapshot.debian.org/package/cbm/
18+
[2]: https://tracker.debian.org/pkg/cbm
19+
20+
## What is CBM? ##
21+
22+
The Color Bandwidth Meter (CBM) is a small program to display the traffic
23+
currently flowing through the network devices in a simple curses-based GUI.
24+
The traffic for all interfaces include values as receive, transfer and total
25+
Bytes/s or bits/s (or its multiples as KB/s and Kb/s).
26+
27+
It is useful for Internet or LAN speed tests, measuring the velocity of a
28+
link, to establish a benchmark or to monitor your connections. CBM can be
29+
used with virtual, wired or wireless networks.
30+
31+
Nowadays, CBM is maintained by volunteers.
32+
33+
## Build and Install ##
34+
35+
CBM depends of libncurses to build.
36+
37+
To build and install, run the following commands:
38+
39+
$ ./autogen.sh
40+
$ ./configure
41+
$ make
42+
# make install
43+
44+
To return to original source code, you can use '$ make distclean' command.
45+
46+
On Debian systems you can use '# apt install cbm'.
47+
48+
## AUTHOR ##
49+
50+
CBM was originally developed by Aaron Isotton <aaron@isotton.com> under GPL-2.
51+
52+
Currently, source code and newer versions are available at
53+
https://github.com/resurrecting-open-source-projects/cbm

0 commit comments

Comments
 (0)