1. Christopher Nilsson
  2. dirwatch

Commits

Christopher Nilsson  committed 078dcfa

cleaned up the README a little

  • Participants
  • Parent commits 47345f4
  • Branches default

Comments (0)

Files changed (1)

File README

View file
  • Ignore whitespace
 
 * File creation,
 
-* File rename/delete,
+* File delete,
 
 * File modification.
 
 The events provided may depend on the host operating system.
 
-Initially support is aimed at Windows machines, but hopefully this will be 
+Initially support is aimed at Windows machines, but this may be 
 extended to other platforms as need arises.
+
+Source code
+-----------
+The source code lives at: 
+
+http://bitbucket.org/otherchirps/dirwatch
+
+
+Requirements
+------------
+You will need to have the pywin32_ extensions installed.
+
+
+Installation
+------------
+Grab a copy of the source code, and run the usual:
+
+``python setup.py install``
+
+
+Testing
+-------
+A small test module is included (in the ``dirwatch/test`` directory). 
+It currently assumes the dirwatch module is importable.
+
+
+Feedback
+--------
+Dirwatch has grown a bit *too* organically, out of small experiments with ``ReadDirectoryChangesW()``, and 
+is still at quite a "works for me" level of quality. Hopefully this will 
+improve with time. 
+
+That said, feel free to point out any problems, or give suggestions on how to do things
+better. 
+
+Either log the bug/idea with the `issue tracker`_, send a bitbucket pull request for your changes, 
+or just shoot me an email.
+
+
+.. _pywin32: http://pypi.python.org/pypi/pywin32
+.. _`issue tracker`: http://bitbucket.org/otherchirps/dirwatch/issues