Commits

Aleksander Zdyb committed ffac881

Added license info and README file

  • Participants
  • Parent commits ebc34b7

Comments (0)

Files changed (2)

NetMonitor@zdyb.tk/extension.js

+ /*
+  * 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
+  * (at your option) any later version.
+  * 
+  * This program is distributed in the hope that it will be useful,
+  * but WITHOUT ANY WARRANTY; without even the implied warranty of
+  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  * GNU General Public License for more details.
+  * 
+  * You should have received a copy of the GNU General Public License
+  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+  */
+
 const St = imports.gi.St;
 const Mainloop = imports.mainloop;
 const Main = imports.ui.main;
+What is NetMonitor?
+===================
+
+NetMonitor is a humble Netspeed (http://projects.gnome.org/netspeed/) replacement for gnome-shell (https://live.gnome.org/GnomeShell)
+
+
+What it looks like?
+===================
+
+Everybody loves screenshots, right?
+
+.. image:: http://img198.imageshack.us/img198/5122/netmonitor1.png
+   :alt: Normal view
+
+.. image:: http://img135.imageshack.us/img135/214/netmonitor5.png
+   :alt: Two connected devices
+
+.. image:: http://img217.imageshack.us/img217/6286/netmonitor4.png
+   :alt: Hidden device
+
+
+Disclaimer
+==========
+
+As I couldn't find any real documentation for writing gnome-shell extensions, I based my code on better or worse snippets and tutorials found on internet. Some of the sources are mentioned below:
+
+* http://git.gnome.org/browse/gnome-shell-extensions/
+* http://blog.fpmurphy.com/tag/gnome-shell
+* https://github.com/paradoxxxzero/gnome-shell-system-monitor-applet
+
+
+How it works?
+=============
+
+The extension connects to NetworkManager via dbus and gets list of available network devices. Then it parses /proc/net/dev file for interfaces' statistics.
+
+I should have used imports.gi.NetworkManager instead of writing all the code myself, but I've found the module too late (did I mention lack of documentation?). Moreover I should have used imports.gi.GTop instead of parsing /proc/net/dev/, but I don't believe it's supported in gnome-shell 3.0.
+
+
+Have fun!
+=========
+
+Go ahead and try:
+
+
+  hg clone http://bitbucket.org/ojo/gnome-shell-extension-netmonitor/
+
+
+Have fun!
+
+
+License
+=======
+
+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 (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.