dirdesc

Dirdesc is directory structure diagram generator from .dirdesc file

install

yarn global add dirdesc

How to use

• put .dirdesc file on project directories and write description

$ echo "some directory description" > path/to/dir/.dirdesc

• run dirdesc command on project root

$ dirdesc

• Generate Directory Structure with description

root
|
├- dir # some description by .dirdesc
|
└- dir2
   |
   ├- child-dir # some description by .dirdesc
   |  |
   |  └- grand-child-dir # some description here...
   |
   └- child-dir2
      |
      ├- grand-child-dir1 # some description here...
      |
      └- grand-child-dir2 # some description here...