diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 0079e4e..0000000 --- a/INSTALL +++ /dev/null @@ -1,28 +0,0 @@ -usbtop: installation instructions -================================= - -Prerequisites: --------------- - * libpcap - * libboost >= 1.48.0 - - Under Debian, install these packages : - - # aptitude install libboost-dev libpcap-dev libboost-thread-dev libboost-system-dev - -Compilation instructions: -------------------------- - -Create a '_build' directory and then use CMake to create the required Makefile's - - $ cd /path/to/usbtop - $ mkdir _build && cd _build - $ cmake -DCMAKE_BUILD_TYPE=Release .. - -Then, compile usbtop: - - $ make - -And install it to /usr/local/bin (as root) and load kernel module (as root) : - - # make install && modprobe usbmon diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..abfa582 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,47 @@ +usbtop: installation instructions +================================= + +Packages +-------- + +Under some Debian-based system, you can directly install the usbtop package: + +``` +$ sudo apt install ubstop +``` + +From sources +------------ + +### Prerequisites: + + * libpcap + * libboost >= 1.48.0 + +Under Debian, install these packages : + +``` +$ sudo apt install libboost-dev libpcap-dev libboost-thread-dev libboost-system-dev +``` + +### Compilation instructions: + +Create a ``_build`` directory and then use CMake to create the required Makefile's + +``` +$ cd /path/to/usbtop +$ mkdir _build && cd _build +$ cmake -DCMAKE_BUILD_TYPE=Release .. +``` + +Then, compile usbtop: + +``` +$ make +``` + +And install it to /usr/local/bin (as root) and load kernel module (as root) : + +``` +# make install && modprobe usbmon +``` diff --git a/README.md b/README.md index 0951142..c46c8e9 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ USB buses and devices. Project status -------------- -Current stable release is 0.1 (tag release-0.1). +Current stable release is 0.2 (tag release-0.2). The project is stable and has been tested on debian systems. It should work on all different flavors of Linux though. Do not hesitate to report any issue you would have while trying to compile and run usbtop. @@ -19,11 +19,11 @@ A ncurses and Qt interfaces with a Windows port are the next steps. Feel free to Usage ----- -Please refer to the INSTALL file for installation instructions. -Then, you need to have the "usbmon" module loaded. As root, do : +Please refer to the ```INSTALL.md``` file for installation instructions. +Then, you need to have the ```usbmon``` module loaded. As root, do : ``` # modprobe usbmon ``` -Moreover, on some distributions, usbtop need to be run as root ! +Moreover, on some distributions, usbtop need to be run as root!