eris/golden-files/help

(B[m[38;2;255;255;255m[48;2;0;0;0m┌────────────────────────────────────────────── Help ──────────────────────────────────────────────┐
│Vigil Code Monitor                                                                                │
│                                                                                                  │
│Vigil shows a list of status reports for a given codebase, and keeps them                         │
│up to date as the codebase changes.                                                               │
│                                                                                                  │
│A set of reports is produced for every file, which depend on the file's type.                     │
│                                                                                                  │
│A status indicator summarises the state of each report, and a report is viewed                    │
│by selecting this status indicator with the cursor.                                               │
│                                                                                                  │
│The reports are cached in the codebase's root directory in a ".vigil"                             │
│directory.                                                                                        │
│                                                                                                  │
│Keys:                                                                                             │
│  arrow keys, page up/down, mouse - Move the cursor or scroll the result pane.                    │
│  tab - Change the focus between summary and result pane.                                         │
│  (B[m[38;2;0;255;0m[48;2;0;0;0mh(B[m[38;2;255;255;255m[48;2;0;0;0m - Show the help screen. (toggle)                                                              │
│  (B[m[38;2;0;255;0m[48;2;0;0;0mq(B[m[38;2;255;255;255m[48;2;0;0;0m - Quit.                                                                                       │
│  (B[m[38;2;0;255;0m[48;2;0;0;0mt(B[m[38;2;255;255;255m[48;2;0;0;0m - Turn the result pane to portrait or landscape orientation. (toggle)                         │
│  (B[m[38;2;0;255;0m[48;2;0;0;0ml(B[m[38;2;255;255;255m[48;2;0;0;0m - Show the activity log. (toggle)                                                             │
│  (B[m[38;2;0;255;0m[48;2;0;0;0me(B[m[38;2;255;255;255m[48;2;0;0;0m - Edit the current file with an editor defined by -e, $EDITOR or $VISUAL.                     │
│  (B[m[38;2;0;255;0m[48;2;0;0;0mn(B[m[38;2;255;255;255m[48;2;0;0;0m - Move to the next issue.                                                                     │
│  (B[m[38;2;0;255;0m[48;2;0;0;0mN(B[m[38;2;255;255;255m[48;2;0;0;0m - Move to the next issue of the current tool.                                                 │
│  (B[m[38;2;0;255;0m[48;2;0;0;0mp(B[m[38;2;255;255;255m[48;2;0;0;0m - Pause workers. (toggle)                                                                     │
│  (B[m[38;2;0;255;0m[48;2;0;0;0mo(B[m[38;2;255;255;255m[48;2;0;0;0m - Order files by type, or by directory location. (toggle)                                     │
│  (B[m[38;2;0;255;0m[48;2;0;0;0mr(B[m[38;2;255;255;255m[48;2;0;0;0m - Refresh the currently selected report.                                                      │
│  (B[m[38;2;0;255;0m[48;2;0;0;0mf(B[m[38;2;255;255;255m[48;2;0;0;0m - Resize the focused pane to the full screen. (toggle)                                        │
│                                                                                                  │
│Statuses:                                                                                         │
│  (B[m[38;2;255;255;255m[48;2;255;255;255m (B[m[38;2;255;255;255m[48;2;0;0;0m Normal                                                                                        │
│  (B[m[38;2;255;255;255m[48;2;0;255;0m (B[m[38;2;255;255;255m[48;2;0;0;0m Ok                                                                                            │
│  (B[m[38;2;255;255;255m[48;2;255;0;0m (B[m[38;2;255;255;255m[48;2;0;0;0m Problem                                                                                       │
│  (B[m[38;2;255;255;255m[48;2;100;100;100m (B[m[38;2;255;255;255m[48;2;0;0;0m Not applicable                                                                                │
│  (B[m[38;2;255;255;255m[48;2;90;90;255m (B[m[38;2;255;255;255m[48;2;0;0;0m Running                                                                                       │
│  (B[m[38;2;255;255;255m[48;2;255;255;0m (B[m[38;2;255;255;255m[48;2;0;0;0m Paused                                                                                        │
│  (B[m[38;2;255;255;255m[48;2;200;0;200m (B[m[38;2;255;255;255m[48;2;0;0;0m Timed out                                                                                     │
│  . Pending                                                                                       │
│  (B[m[38;2;255;255;255m[48;2;255;0;0mE(B[m[38;2;255;255;255m[48;2;0;0;0m Error                                                                                         │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
│                                                                                                  │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘(B[m
-												Use a more common terminal type.

											
										
										
											2016-10-26 14:09:05 +02:00
+								(B[m[38;2;255;255;255m[48;2;0;0;0m┌────────────────────────────────────────────── Help ──────────────────────────────────────────────┐
-												Improved the project description.

											
										
										
											2016-09-30 15:37:29 +02:00
+								│Vigil Code Monitor                                                                                │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│                                                                                                  │
-												Improved the project description.

											
										
										
											2016-09-30 15:37:29 +02:00
+								│Vigil shows a list of status reports for a given codebase, and keeps them                         │
 								│up to date as the codebase changes.                                                               │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│                                                                                                  │
-												Improved the project description.

											
										
										
											2016-09-30 15:37:29 +02:00
+								│A set of reports is produced for every file, which depend on the file's type.                     │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│                                                                                                  │
-												Improved the project description.

											
										
										
											2016-09-30 15:37:29 +02:00
+								│A status indicator summarises the state of each report, and a report is viewed                    │
-												Not showing the statuses in the cmdline help.

											
										
										
											2016-11-11 20:54:26 +01:00
+								│by selecting this status indicator with the cursor.                                               │
-												Improved the project description.

											
										
										
											2016-09-30 15:37:29 +02:00
+								│                                                                                                  │
-												Coding style (linting).

											
										
										
											2016-10-16 12:32:01 +02:00
+								│The reports are cached in the codebase's root directory in a ".vigil"                             │
 								│directory.                                                                                        │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│                                                                                                  │
 								│Keys:                                                                                             │
-												Trying different keys for navigation.

I was having problems with the old scheme.
Now you use tab to switch focus between the summary and result
panes. The keys to navigate are the same in both places.

											
										
										
											2016-10-27 21:32:45 +02:00
+								│  arrow keys, page up/down, mouse - Move the cursor or scroll the result pane.                    │
 								│  tab - Change the focus between summary and result pane.                                         │
-												Use a more common terminal type.

											
										
										
											2016-10-26 14:09:05 +02:00
+								│  (B[m[38;2;0;255;0m[48;2;0;0;0mh(B[m[38;2;255;255;255m[48;2;0;0;0m - Show the help screen. (toggle)                                                              │
 								│  (B[m[38;2;0;255;0m[48;2;0;0;0mq(B[m[38;2;255;255;255m[48;2;0;0;0m - Quit.                                                                                       │
 								│  (B[m[38;2;0;255;0m[48;2;0;0;0mt(B[m[38;2;255;255;255m[48;2;0;0;0m - Turn the result pane to portrait or landscape orientation. (toggle)                         │
 								│  (B[m[38;2;0;255;0m[48;2;0;0;0ml(B[m[38;2;255;255;255m[48;2;0;0;0m - Show the activity log. (toggle)                                                             │
 								│  (B[m[38;2;0;255;0m[48;2;0;0;0me(B[m[38;2;255;255;255m[48;2;0;0;0m - Edit the current file with an editor defined by -e, $EDITOR or $VISUAL.                     │
 								│  (B[m[38;2;0;255;0m[48;2;0;0;0mn(B[m[38;2;255;255;255m[48;2;0;0;0m - Move to the next issue.                                                                     │
 								│  (B[m[38;2;0;255;0m[48;2;0;0;0mN(B[m[38;2;255;255;255m[48;2;0;0;0m - Move to the next issue of the current tool.                                                 │
 								│  (B[m[38;2;0;255;0m[48;2;0;0;0mp(B[m[38;2;255;255;255m[48;2;0;0;0m - Pause workers. (toggle)                                                                     │
 								│  (B[m[38;2;0;255;0m[48;2;0;0;0mo(B[m[38;2;255;255;255m[48;2;0;0;0m - Order files by type, or by directory location. (toggle)                                     │
 								│  (B[m[38;2;0;255;0m[48;2;0;0;0mr(B[m[38;2;255;255;255m[48;2;0;0;0m - Refresh the currently selected report.                                                      │
-												Let the focused pane be resized to the full screen.

											
										
										
											2016-10-29 14:07:17 +02:00
+								│  (B[m[38;2;0;255;0m[48;2;0;0;0mf(B[m[38;2;255;255;255m[48;2;0;0;0m - Resize the focused pane to the full screen. (toggle)                                        │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│                                                                                                  │
 								│Statuses:                                                                                         │
-												Use a more common terminal type.

											
										
										
											2016-10-26 14:09:05 +02:00
+								│  (B[m[38;2;255;255;255m[48;2;255;255;255m (B[m[38;2;255;255;255m[48;2;0;0;0m Normal                                                                                        │
 								│  (B[m[38;2;255;255;255m[48;2;0;255;0m (B[m[38;2;255;255;255m[48;2;0;0;0m Ok                                                                                            │
 								│  (B[m[38;2;255;255;255m[48;2;255;0;0m (B[m[38;2;255;255;255m[48;2;0;0;0m Problem                                                                                       │
 								│  (B[m[38;2;255;255;255m[48;2;100;100;100m (B[m[38;2;255;255;255m[48;2;0;0;0m Not applicable                                                                                │
 								│  (B[m[38;2;255;255;255m[48;2;90;90;255m (B[m[38;2;255;255;255m[48;2;0;0;0m Running                                                                                       │
 								│  (B[m[38;2;255;255;255m[48;2;255;255;0m (B[m[38;2;255;255;255m[48;2;0;0;0m Paused                                                                                        │
 								│  (B[m[38;2;255;255;255m[48;2;200;0;200m (B[m[38;2;255;255;255m[48;2;0;0;0m Timed out                                                                                     │
-												Only have the simple style of statuses.

The double width character wasn't common and often didn't work depending
on terminal or font.

											
										
										
											2016-09-30 12:57:43 +02:00
+								│  . Pending                                                                                       │
-												Use a more common terminal type.

											
										
										
											2016-10-26 14:09:05 +02:00
+								│  (B[m[38;2;255;255;255m[48;2;255;0;0mE(B[m[38;2;255;255;255m[48;2;0;0;0m Error                                                                                         │
-												Only have the simple style of statuses.

The double width character wasn't common and often didn't work depending
on terminal or font.

											
										
										
											2016-09-30 12:57:43 +02:00
+								│                                                                                                  │
-												Make the window in help's golden file bigger, now that theres more help.

											
										
										
											2016-01-29 21:29:44 +00:00
+								│                                                                                                  │
 								│                                                                                                  │
-												Not showing the statuses in the cmdline help.

											
										
										
											2016-11-11 20:54:26 +01:00
+								│                                                                                                  │
-												Showing different help on the help page and the command-line.

											
										
										
											2016-09-30 21:28:05 +02:00
+								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
 								│                                                                                                  │
-												Use a more common terminal type.

											
										
										
											2016-10-26 14:09:05 +02:00
+								└──────────────────────────────────────────────────────────────────────────────────────────────────┘(B[m