Do all the things like ++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatarSign Up
Jilano2626966d"If you're reading that, it means I am dead." That seems like a good intro, whatever you'll write after that should work
Jilano2626966d@mr-user "While you might think you've been chosen to inherit a secret knowledge, you couldn't be more wrong. In fact, my writing talent is so horrendous, you could very well end up stupider after reading that documentation.
That's it, my boy. No more. It's over.
I would like to say that you now possess the weapon for this fight, but we both know that's not true. Anyway, don't hesitate to hit me up in case you're in trouble. Wait...! I forgot, I'm dead! Ha!"
I am going to be a ghost which hunt both developers and managers.
For developers : "There's a bug......F..i...x... it"
For managers : "Chan..ge... the deadline...."
melezorus34169666dJust create a rabbit hole that will connect to an API to automatically announce you are dead.
webketje74766d@mr-user "it will be the most important I have written up my whole life" sounds kinda sad.
But to your question: google "good readme" or look around Github for some popular open-source projects for inspiration. Usually there s sections like Getting Started, Local setup, Build, Deploy, Business logic, etc