[{"data":1,"prerenderedAt":72},["ShallowReactive",2],{"term-r\u002Freadme":3,"related-r\u002Freadme":59},{"id":4,"title":5,"acronym":5,"body":6,"category":39,"description":40,"difficulty":41,"extension":42,"letter":43,"meta":44,"navigation":45,"path":46,"related":47,"seo":52,"sitemap":53,"stem":56,"subcategory":57,"__hash__":58},"terms\u002Fterms\u002Fr\u002Freadme.md","README",{"type":7,"value":8,"toc":32},"minimark",[9,14,18,22,25,29],[10,11,13],"h2",{"id":12},"eli5-the-vibe-check","ELI5 — The Vibe Check",[15,16,17],"p",{},"A README is the instruction manual taped to the front of a code project. It tells newcomers what the project does, how to install it, and how to use it. Without it, you're handing someone a mystery box and walking away.",[10,19,21],{"id":20},"real-talk","Real Talk",[15,23,24],{},"A README is a markdown file at the root of a project that provides an overview, installation instructions, usage examples, and contribution guidelines. It is the first thing users and contributors see on GitHub or any code-hosting platform.",[10,26,28],{"id":27},"when-youll-hear-this","When You'll Hear This",[15,30,31],{},"\"Update the README with the new environment variables.\" \u002F \"The README is outdated — it still references the old API.\"",{"title":33,"searchDepth":34,"depth":34,"links":35},"",2,[36,37,38],{"id":12,"depth":34,"text":13},{"id":20,"depth":34,"text":21},{"id":27,"depth":34,"text":28},"general","A README is the instruction manual taped to the front of a code project. It tells newcomers what the project does, how to install it, and how to use it.","beginner","md","r",{},true,"\u002Fterms\u002Fr\u002Freadme",[48,49,50,51],"Documentation","Markdown","Open Source","Boilerplate",{"title":5,"description":40},{"changefreq":54,"priority":55},"weekly",0.7,"terms\u002Fr\u002Freadme",null,"Z1yE1ok6miC9fxr7hgPgxkyzVIej4dBjjqpd-cUYAT0",[60,63,66,69],{"title":51,"path":61,"acronym":57,"category":39,"difficulty":41,"description":62},"\u002Fterms\u002Fb\u002Fboilerplate","Code you have to write every single time you start a project but that doesn't actually do anything interesting.",{"title":48,"path":64,"acronym":57,"category":39,"difficulty":41,"description":65},"\u002Fterms\u002Fd\u002Fdocumentation","Documentation is written explanation of how your code works and why.",{"title":49,"path":67,"acronym":57,"category":39,"difficulty":41,"description":68},"\u002Fterms\u002Fm\u002Fmarkdown","Markdown is a simple way to format text using just plain characters. Put `**asterisks**` around a word and it becomes **bold**.",{"title":50,"path":70,"acronym":57,"category":39,"difficulty":41,"description":71},"\u002Fterms\u002Fo\u002Fopen-source","Open source means the recipe is public. Anyone can read it, copy it, tweak it, and share their version. It's the opposite of a secret sauce.",1776518305337]