Skip to content
/ dh Public

A small commandline tool for showing simple custom help files.

License

Notifications You must be signed in to change notification settings

workingj/dh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dh (display help)

MIT licensed

A simple commandline tool for showing custom help files or notes. Waits for retrun key after 32 lines and shows the next 32 lines.

build

$ cargo build --release

Register dh in the environment variables, so you can run it from the commandline with
$ dh [argument]

Will show the contents of the git.toml file.

INSTRUCTION

Create your helpfiles in the root directory of dh or, set a location with the environment var 'DH_LIBRARY' and put your helpfiles there.

Files

Use '.toml' for File extension.

USAGE EXAMPLE

Filename      Command       Output
help.toml     $ dh help     this file!
yours.toml    $ dh yours    what ever you have jotted down.
              $ dh          Lists all Helpfiles within the 'DH_LIBRARY'-Location

HIGHLIGHTING

Lines that start with '#','##','###, *, //' will be highlighted

'# '   HEADER 1   in Green
'## '  Header 2  in Blue
'### ' Header 3 in Turkoise
'$ ' Commad Line  in Oragen
'// '  Comment   in Slate Blue
'* ' Bullet Point in Chartreuse

About

A small commandline tool for showing simple custom help files.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published