Skip to content

Commit

Permalink
Fix version in README and INSTALL instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
aguinet committed Feb 26, 2019
1 parent 61cb94a commit 71f1014
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 32 deletions.
28 changes: 0 additions & 28 deletions INSTALL

This file was deleted.

47 changes: 47 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -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
```
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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!

0 comments on commit 71f1014

Please sign in to comment.