diff --git a/README b/README deleted file mode 100644 index fbe593e53c8e07a18212830a4bd5a9071f32f3e4..0000000000000000000000000000000000000000 --- a/README +++ /dev/null @@ -1,23 +0,0 @@ -Crontab linter. - -chkcrontab is a script to check crontab files like those in -/etc/cron.d and /etc/crontab. It tries to catch glaring errors -and warn on suspect lines in a crontab file. Some valid lines -will generate warnings. Certain silly yet valid crontab lines -will generate errors as well. - -Run this by doing ./chkcrontab crontab_file - -Errors will cause a non-zero exit code. Warnings alone will not. - -To see sample output for a bad crontab, run the following: - - ./chkcrontab ./tests/test_crontab - -See the ./tests/test_crontab.disable crontab for how to disable -warnings and errors. - -CONTRIBUTIONS - -Please add unit tests for new features or bug fixes. To run all -the unitests run ./setup test. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..7dbc6cbba4c9520dcc531238db4a146dbfbe8184 --- /dev/null +++ b/README.rst @@ -0,0 +1,34 @@ +========== +chkcrontab +========== +.. image:: https://secure.travis-ci.org/lyda/chkcrontab.png + :target: https://secure.travis-ci.org/lyda/chkcrontab + :alt: Build status + +Crontab linter +============== + +chkcrontab is a script to check crontab files like those in +``/etc/cron.d`` and ``/etc/crontab``. It tries to catch glaring +errors and warn on suspect lines in a crontab file. Some valid +lines will generate warnings. Certain silly yet valid crontab lines +will generate errors as well. + +Run this by doing:: + + chkcrontab crontab_file + +Errors will cause a non-zero exit code. Warnings alone will not. + +To see sample output for a bad crontab, run the following:: + + ./chkcrontab ./tests/test_crontab + +See the ``./tests/test_crontab.disable`` crontab for how to disable +warnings and errors. + +Contributions +============= + +Please add unit tests for new features or bug fixes. To run all +the unit tests run ``./setup test``.