fix readme

[stack/code/dboxswitch.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..9dcd730
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+Dboxswitch
+==========
+
+dboxswitch is a small utility to create and maintain different
+_dropbox profiles_, and using them separately by switching from one to another
+trough a simple interface in the systray.
+
+It sits in your sistray and clicking on its icon you could create
+and switch profile, dropbox will be restarted in an empty directory
+without touching your files, and you have the possibility to start 
+with a different registered user and configuring dropbox as usual.
+
+Intsallation
+============
+launch without installing system wide with
+
+    python dboxswitch
+where dboxswitch is the directory containing `__main__.py`
+
+PyQt4 must be installed on the system
+
+for debian like distro do 
+
+    apt-get install python-qt4
+    or
+    python3-pyqt4
+
+
+    note that also python-setuptools should be installed for the source to be build
+
+install with
+
+    python setup.py install
+
+launch with
+
+    dboxswitch