#103·realworld

Standardize README's for completed repos

Author: EricSimonsCreated May 5, 2017Updated Jan 1, 2022
LabelsStatus: RFCv2 changelog

For someone who is landing on an example repo and has no idea what RealWorld is, I'd imagine they'd be thinking "uh, wtf is this". For example, the backend codebases don't mention how to get an example frontend setup & running (much less where you can choose a frontend at all). This could easily be fixed with a standard "what is this"-esque section at the top of every README.

Further, would be great to have standard sections on common topics like "Installing Dependencies", "Running the Application", "Architecture Overview", etc that people will typically be looking for. Definitely a key improvement for the UX of perusing/exploring repo's.

Would love thoughts on this!

Source: realworld-apps/realworld