Commits

Yujie Wu  committed 8db0c1b

Added "How to install" section of documentation, and adjusted the usage description.

  • Participants
  • Parent commits 9704c26
  • Branches develop

Comments (0)

Files changed (1)

 #!/usr/bin/python
 #
 # This program is an implementation of the cron server/daemon.
-# A brief description of its usage:
-#   1. Simple configuration: Set the paths of the log file, the crontab file, and the lock file in the 'mucron_config.py' file.
+# - How to install
+#   1. You need to install a third party module: python-daemon. You can download it from here:
+#      http://pypi.python.org/pypi/python-daemon/
+#   2. Save 'mucron.py' and 'mucron_config.py' in the same directory (any directory is fine).
+#
+# - How to use
+#   1. Simple configuration: Set the paths of the log file, the crontab file, and the lock file, in the 'mucron_config.py' file.
 #      The lock file is a zero byte file whose purpose is to prevent running multiple 'mucron' daemons.
-#   2. Run 'mucron.py'.
-#   3. Set your crontabs in your crontab file as specified in the configuration file: 'mucron_config.py'. The syntax of crontab
-#      follows the standard. You can modify the crontab file at any time. An example file: 'crontab' is provided in the package.
+#   2. Execute 'mucron.py' or 'python mucron.py'.
+#   3. Set your crontabs in the specified crontab file. The syntax of crontab follows the standard. You can modify the crontab
+#      file at any time. An example file: 'crontab' is provided in the package.
 #
 # 
 # Copyright (C) 2009-2012, Yujie Wu.