Imagine a stranger arrives at your project at three in the morning. They have come to fix something urgent. They will not meet you. They will only meet what you left behind.
Stanza I
The stranger at the door
The README is the lamp by the door. Light it well.
Stanza II
What it should always say
What is this. Why does it exist. How do I run it locally in under five minutes. Where does it live in production. Who do I wake up if it breaks.
If your README answers those five questions, you have honoured the stranger at the door.
End of scroll
Sensey Team
Sensey · Craft