Provide detailed installation instructions

magnific0 · Dec 6, 2017 · f4405e8 · f4405e8
1 parent 6308ab9
commit f4405e8
Showing 1 changed file with 56 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -17,11 +17,63 @@ Wonder Shaper is a script that allow the user to limit the bandwidth of one or m
 Installation
 --------------
 
-You can run wondershaper (as any user with sufficient permissions) without
-installation. However if you want to install the script onto your system you can
-simply run:
+### Obtaining wondershaper
 
-        sudo make install
+It is recommended to clone the GitHub repository of wondershaper such that you can pull in new updates at any time (if available). Open a new terminal and clone the repository using
+
+    git clone  https://github.com/magnific0/wondershaper.git
+
+This will clone wondershaper in your current folder in a new folder named wondershaper. Now enter the folder using
+
+    cd wondershaper
+
+### Using wondershaper
+
+You can run wondershaper (as any user with sufficient permissions) without installation and stop following the instructions at this point. Show the wondershaper usage instructions by typing
+
+    ./wondershaper -h
+
+The program details all available options on how to use wondershaper. Next is to pick an interface that you want to shape. You can see all availble interfaces by typing
+
+    ip addr show
+
+Note that on older systems this command might not be available. In this case you should run ```ifconfig``` instead.
+
+Identify the network interface that you want to shape. The names [differ per system](https://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames/).
+
+In the following example a wireless interface is limited to an [upload of 4Mbps and download of 8Mbps](http://whatsabyte.com/).
+
+    ./wondershaper -a wlp4s0 -u 4096 -d 8192
+
+If you get messages telling you that ```RTNETLINK answers: Operation not permitted``` your user account does not have sufficient priviliges. In that case try:
+
+    sudo ./wondershaper -a wlp4s0 -u 4096 -d 8192
+
+### System installation (optional)
+
+A makefile file provided for easy installation. The default location for wondershaper is in ```/usr/bin```. If you want to install to your system you can run:
+
+    sudo make install
+        
+You can verify that wondershaper was installed correctly by entering:
+
+    which wondershaper
+
+This should return ```/usr/bin/wondershaper```. You can follow the same instructions as explained in the "Using wondershaper" section, but instead of running the local version of the program you now run the system version by removing the ```./``` from the beginning of each command. For example to show the help instructions again run:
+
+    wondershaper -h
+
+### Persistent usage of wondershaper (optional)
+
+To make sure wondershaper is reactivated on reboot a systemd service file is provided. First enable wondershapre as a systemd service using:
+
+    sudo systemctl enable wondershaper.service 
+
+Instead of using the commandline options to set the rates and interface as previously shown, it is necessary to set these parameters in the ```wondershaper.conf``` configuration file. You can edit this file using your favourite text editor (nano in the example below) as such:
+
+    sudo nano /etc/conf.d/wondershaper.conf
+
+This way wondershaper is activated with your setting upon reboot.
 
 Usage
 --------------