summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastien Martini <seb@dbzteam.org>2010-10-17 18:43:23 +0200
committerSebastien Martini <seb@dbzteam.org>2010-10-17 18:43:23 +0200
commit095323cb53ec49e7e04b09ddb6908adfbfd2564f (patch)
tree7b6b5fead35b74213659b3014b881554188ff6a8
parent6a2a526ff2e7c0beb7a7df7bb3ec3f93c0568c6c (diff)
downloadpyinotify-095323cb53ec49e7e04b09ddb6908adfbfd2564f.tar.gz
Updated README to use markdown syntax.
-rw-r--r--README34
1 files changed, 0 insertions, 34 deletions
diff --git a/README b/README
deleted file mode 100644
index ce25fb2..0000000
--- a/README
+++ /dev/null
@@ -1,34 +0,0 @@
-==== Pyinotify ====
-
-License : MIT License
-Project URL : http://github.com/seb-m/pyinotify
-Project Wiki : http://github.com/seb-m/pyinotify/wiki
-Generated documentation : http://seb-m.github.com/pyinotify
-
-==== Dependencies ====
-
-- Linux >= 2.6.13
-- Python (CPython) >= 2.4
-- Libc with inotify support (usually version >= 2.4 for GLibc)
-- ctypes (part of the standard library since Python 2.5)
-- Epydoc (optional, used to generate html documentation from docstrings)
-
-
-==== Install ====
-
--> Install from the distributed tarball
- # Choose your Python interpreter: either python, python2.6, python3.0,..
- # Replacing XXX accordingly with your previous choice type:
- $ sudo pythonXXX setup.py install
-
--> OR install with "Easy Install" (currently seems to work only for Python2)
- $ wget http://peak.telecommunity.com/dist/ez_setup.py
- $ sudo python ez_setup.py
- $ sudo easy_install pyinotify
-
-
-==== Watch a directory ====
-
-Install pyinotify and run this command from a shell:
-
- $ python -m pyinotify -v /my-dir-to-watch