Your README.md is obsolete

README.md is that one file in every project that gets the princess treatment from GitHub, GitLab, and other source code hosting platforms. It is displayed gloriously at front of every project page. IntelliJ even casually opens it the moment you import a new project, while it goes off indexing the tech debt— err, codebase.But, when did you last update your README.md? Was it created during project's genesis and the last commit message there is still "initial commit"? Did it come bundled with the project starter template and remains untouched ever since?When it comes to personal side-project repositories, I am guilty of this too. I usually include the bare minimum—just enough for me to remember what commands to run, plus a few references so that I don't have to go down hunting my terminal's history with history | grep xyz when (or if) I reopen it back months later. Handovers would be messy.It is 2024—no, wait, 2026. The world has finally picked up its pace after the pandemic slowdown.…