unman/shaker

Lacks some minimal doc

Opened this issue · 1 comments

It requires quite some dedication today to make sense of this material. The following would IMHO improve tremendously its usefulness:

  • a README for each directory -- the one in cacher/ does help, and the format would also benefit from some enhancements (e.g. explain what each qubesctl invocation achieves; use markdown formatting)
  • a toplevel README, which would possibly list projects in increasing complexity, and explain shortly what they demonstrate

I think anyone trying to get a grip on salt should start here:
https://github.com/unman/notes/blob/master/salt/Index

Agreed though with previous comment.