Updated documentation for 0.2 release

[mtetherd] / README

diff --git a/README b/README
index 613db3f..5d54699 100644 (file)
--- a/README
+++ b/README
@@ -1,20 +1,25 @@
-maemo-tethering 1.0
--------------------
+mtetherd 0.1
+------------
 
 Description:
 
-maemo-tethering allows you to use your N900 as an Internet router.
+mtetherd allows you to use your N900 as an Internet router.
 Once a USB network or Bluetooth PAN connection is opened to the device,
 it will automatically configure networking and start a dnsmasq instance
 that serves DHCP requests and forwards DNS queries.
-This tool can also be used to automatically configure network interfaces
+You can also use it to automatically configure network interfaces
 for development.
 
+Requirements:
+
+The iptables and bluetooth-dun packages must be installed.
+They are required for setting up NAT and Bluetooth PAN support.
+
 Usage:
 
 Bluetooth:
 1. Pair your host with the N900 and make sure the PAN (Bluetooth networking)
-   service is recognized.
+   service is recognized on the host.
 2. Open a PAN connection to the N900.
 3. Routing should setup automatically and you can access the Internet
    right away.
@@ -22,12 +27,11 @@ Bluetooth:
 USB:
 1. Connect host and N900 with a USB cable.
 2. Wait until the USB mode dialog pops up on the N900 and dismiss it.
-3. Open MAD Developer.
-4. Tap "Manage USB".
-5. Tap "Load g_ether".
+3. Open the status menu (the small icons to the right of the clock)
+4. Tap "Toggle USB Networking"
+5. Start surfing
 6. The USB mode is kept between cable disconnects, you only have to
    reload the g_ether module after a reboot or mode change.
-7. Start surfing on the host.
 3a.It is also possible to load the module from the Terminal:
 rmmod g_nokia
 rmmod g_file_storage
@@ -35,11 +39,12 @@ modprobe g_ether
 
 Notes:
 
-IP addresses are currently hardcoded into the program. A later version
-will add support for a configuration file.
-The assigned addresses are the following:
-USB: N900: 192.168.253.254 DHCP: 192.168.253.1-192.168.253.253
-Bluetooth: N900: 192.168.254.254 DHCP: 192.168.254.1-192.168.254.253
+IP addresses are assigned dynamically from the 192.168.255.0/24 range.
+Each network device gets a /30 subnet, of which the first address
+will be assigned to the N900 and the second provided via DHCP.
+This gives the following addresses for the first interface (usually
+Bluetooth): N900: 192.168.255.1 Host: 192.168.255.2
+And the second device: N900: 192.168.255.5 Host: 192.168.255.6
 
 If you connect while no GPRS/UMTS connection is active, forwarding will
 not be enabled. This is the case when the device is connected to a
@@ -48,8 +53,16 @@ You can still communicate with the device, but not surf the internet
 from your host. Just disconnect and reconnect again when the GPRS/UMTS
 connection is available.
 
+Bugs:
+
+If you find any, please report them via the Maemo Garage bug tracker at
+https://garage.maemo.org/projects/mtetherd/ or send an email to
+onitake@gmail.com
+
 Legal:
 
+mtetherd is (c) 2010 by Gregor Riepl <onitake@gmail.com>
+
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or