doc

Documentation specs

Filesystem

A module repo shall have:

• a viewme.png
• a readme.md or readme.txt

Optional:

• a LICENSE file

Folders inside can be named

• source
• build
• datasheet
• images
• doc -> Other folders can be detected

Blocks to be detected in Readme.md

• Name (between ')
• Title
• Description (with subitems)
• Inputs
• Outputs
• What is it supposed to do?

To build the graph of the module, I use

• How does it work: block diagram

To build my todos, I use

• TODO
• DONE

To be discussed:

Blog posts under the filename YYYY-MM-DD.md ?

Others

Emojis

Cheat sheet at http://www.webpagefx.com/tools/emoji-cheat-sheet/

• ⛔ or 🔴 or ❌ or 💔 ⛔ or 🔴 or ❌

• ✅ or 💚

• ⚠️