Improved the project description.

This commit is contained in:
Andrew Hamilton 2016-09-30 15:37:29 +02:00
parent d5c094260f
commit 5e0a465e33
2 changed files with 18 additions and 18 deletions

View file

@ -1,15 +1,16 @@
┌────────────────────────────────────────────── Help ──────────────────────────────────────────────┐ ┌────────────────────────────────────────────── Help ──────────────────────────────────────────────┐
│Vigil maintains a set of reports for each file in a directory tree. │ │Vigil Code Monitor │
│Different types of reports are produced for different types of file. │
│ │ │ │
│The state of each report is summarised by a status indicator, and a report is │ │Vigil shows a list of status reports for a given codebase, and keeps them │
│viewed by selecting this status indicator with the cursor. The types of status │ │up to date as the codebase changes. │
│are listed below. │
│ │ │ │
│Reports are recalculated whenever files are changed, so that they are always up │ │A set of reports is produced for every file, which depend on the file's type. │
│to date. │
│ │ │ │
│The reports are cached in a directory ".vigil" under the target directory. │ │A status indicator summarises the state of each report, and a report is viewed │
│by selecting this status indicator with the cursor. The types of status are │
│listed below. │
│ │
│The reports are cached in the codebase's root directory in a ".vigil" directory. │
│ │ │ │
│ │ │ │
│Usage: │ │Usage: │
@ -56,5 +57,4 @@
│ │ │ │
│ │ │ │
│ │ │ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘ └──────────────────────────────────────────────────────────────────────────────────────────────────┘

18
vigil
View file

@ -4,18 +4,18 @@
# Copyright (C) 2015-2016 Andrew Hamilton. All rights reserved. # Copyright (C) 2015-2016 Andrew Hamilton. All rights reserved.
# Licensed under the Artistic License 2.0. # Licensed under the Artistic License 2.0.
"""\ """Vigil Code Monitor
Vigil maintains a set of reports for each file in a directory tree.
Different types of reports are produced for different types of file.
The state of each report is summarised by a status indicator, and a report is Vigil shows a list of status reports for a given codebase, and keeps them
viewed by selecting this status indicator with the cursor. The types of status up to date as the codebase changes.
are listed below.
Reports are recalculated whenever files are changed, so that they are always up A set of reports is produced for every file, which depend on the file's type.
to date.
The reports are cached in a directory ".vigil" under the target directory. A status indicator summarises the state of each report, and a report is viewed
by selecting this status indicator with the cursor. The types of status are
listed below.
The reports are cached in the codebase's root directory in a ".vigil" directory.
Usage: Usage: