Sometimes a directory structure needs a little extra information. Even the most well thought-out directory names lack the expressiveness of a few short remarks. My solution for these cases has been to add a file named
__dir_info__.txt to a directory requiring additional details. This file provides an explanation of the directory's purpose, which typically starts with
This directory contains ..., and is formatted using AsciiDoc.
Let's look at an example:
= foobar :date: 5 January 2015 …