: Re: Writing a programming book: how to present directory structures What is good/preferred way of presenting directory trees in programming books? My main criteria are following: It should be readable

@Shelley992

Vote Up Vote Down

Wasabi offers two approaches to it (you can find them both here)

either indented

root/ # entry comments can be inline after a '#'
# or on their own line, also after a '#'

readme.md # a child of, 'root/', it's indented
# under its parent.

usage.md # indented syntax is nice for small projects
# and short comments.

src/ # directories MUST be identified with a '/'
fileOne.txt # files don't need any notation
fileTwo* # '*' can identify executables
fileThree@ # '@' can identify symlinks

or detailed

root/
this is a comment on 'root'

root/readme.md
comments are indented under their entry this
comment is for 'readme.md', a child of 'root/'
it's specified by the full path

root/usage.md
the detailed syntax is good for large projects
and comprehensive commenting

root/src/
directories MUST be identified with a trailing '/'

root/src/file.txt # some file

(0)

Login to post a comment!