“First impressions count, so take a look at the README for your project’s GitHub repo,” says Liz Rice, VP of open source engineering at Aqua Security. “This is often the first thing that a potential user might see, so it needs to make it very clear what this project will do and how it’s going to solve a problem. It also needs to give clear instructions on how to install and run the tool.”
Here’s a writer’s advice: Put yourself in the mind frame of someone who has zero knowledge of your project or what it does. Will they be able to clearly grasp the fundamentals from your README intro and instructions? Could they explain it to someone else in plain terms? If not, it’s time for a reboot.
