diff options
Diffstat (limited to '')
| -rw-r--r-- | README | 47 | ||||
| -rw-r--r-- | README.md | 53 |
2 files changed, 53 insertions, 47 deletions
@@ -1,47 +0,0 @@ -1) Synopsis ------------ - -wavemon is a wireless device monitoring application that allows you to watch -signal and noise levels, packet statistics, device configuration and network -parameters of your wireless network hardware. It should work (though with -varying features) with all devices supported by the Linux wireless kernel -extensions by Jean Tourrilhes. - -See the man page for an in-depth description of operation and configuration. - - -2) Where to obtain ------------------- -Apart from debian/ubuntu packages (apt-cache search wavemon) and slackbuild -scripts for wavemon on slackbuilds.org, up-to-date sources are available at - - http://www.erg.abdn.ac.uk/ergcms/wavemon/ - -Please check this page for updates and for further information. -wavemon is distributed under the GPLv3, refer to the file COPYING. - - -3) How to build ---------------- -wavemon uses autoconf, so that in most cases you can simply run - - ./configure - make - sudo make install - -to build and install the package. Type 'make uninstall' if not happy. -Refer to the file INSTALL for generic installation instructions. - -To grant users access to restricted networking operations (e.g. reading WEP -keys or performing scan operations), use additionally - - sudo make install-suid-root - -If you have changed some of the autoconf files or use a git version, run - ./config/bootstrap -(requires a recent installation of 'autotools'). - - -3) Bugs? --------- -Send bug reports, comments, and suggestions to <gerrit@erg.abdn.ac.uk>. diff --git a/README.md b/README.md new file mode 100644 index 0000000..637f639 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ + + +## Synopsis + +wavemon is a wireless device monitoring application that allows you to watch +signal and noise levels, packet statistics, device configuration and network +parameters of your wireless network hardware. It should work (though with +varying features) with all devices supported by the Linux kernel. + +See the man page for an in-depth description of operation and configuration. + + +### Where to obtain + +Apart from debian/ubuntu packages (apt-cache search wavemon) and slackbuild +scripts for wavemon on slackbuilds.org, this repository contains the full +source code. + +Please check this page for updates and for further information. +wavemon is distributed under the [GPLv3](http://www.gnu.org/licenses/gpl-3.0.en.html), refer to the file `COPYING`. + + +## How to build + +wavemon uses `autoconf`, so that in most cases you can simply run +``` + ./configure + make + sudo make install +``` +to build and install the package. Type 'make uninstall' if not happy. +Refer to the file `INSTALL` for generic installation instructions. + +**Dependencies**: at least version 3.2 of `libnl`, including the Generic Netlink support (`libnl-genl`). +On Debian/Ubuntu, this can be done using +```bash + apt-get -y install libnl-3-dev libnl-genl-3-dev +``` + +To grant users access to restricted networking operations (scan operations), use additionally +``` + sudo make install-suid-root +``` +If you have changed some of the autoconf files or use a git version, run +``` + ./config/bootstrap +``` +(requires a recent installation of `autotools`). + + +## Bugs? + +Send bug reports, comments, and suggestions by opening an issue on [github](https://github.com/uoaerg/wavemon/issues). |