--- title: Run README.md in your terminal | daily.dev description: README is a markdown-based README.md file that lives in your repo’s version control. It has become part of modern development culture, and you will find them... canonical: https://daily.dev/posts/run-readme-md-in-your-terminal-xrqhgkdgf twitter:card: summary_large_image twitter:site: @dailydotdev og:type: website og:site_name: daily.dev og:title: Run README.md in your terminal | daily.dev og:description: README is a markdown-based README.md file that lives in your repo’s version control. It has become part of modern development culture, and you will find them... og:url: https://daily.dev/posts/run-readme-md-in-your-terminal-xrqhgkdgf og:image: https://api.daily.dev/og/posts/xRQhGkdgf.png og:image:alt: Run README.md in your terminal og:image:width: 1200 og:image:height: 630 og:locale: en --- > ## Documentation Index > Fetch the complete documentation index at: https://daily.dev/llms.txt > Use this file to discover all available pages before exploring further. # Run README.md in your terminal **[Community Picks](https://daily.dev/sources/community)** · 3 min read · 79 upvotes · 3 comments ## Summary README is a markdown-based README.md file that lives in your repo’s version control. It has become part of modern development culture, and you will find them everywhere. ## Full article daily.dev links to this article rather than hosting it. Read it at the original source: ## Community discussion Top comments from developers on daily.dev. **@rogan** · 6 upvotes >  **@huncho254** · 0 upvotes > 😎 **@abser** · 0 upvotes > It seems so cool! --- Tags: [#github](https://daily.dev/tags/github), [#markdown](https://daily.dev/tags/markdown) [View this post on daily.dev](https://daily.dev/posts/run-readme-md-in-your-terminal-xrqhgkdgf) ```json {"@context":"https://schema.org","@graph":[{"@type":"Organization","@id":"https://daily.dev/#organization","name":"daily.dev","url":"https://daily.dev","logo":{"@type":"ImageObject","url":"https://daily.dev/apple-touch-icon.png","width":180,"height":180},"sameAs":["https://twitter.com/dailydotdev","https://github.com/dailydotdev","https://www.linkedin.com/company/daily-dev-ltd"]},{"@type":"WebSite","@id":"https://daily.dev/#website","url":"https://daily.dev","name":"daily.dev","publisher":{"@id":"https://daily.dev/#organization"},"potentialAction":{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https://daily.dev/search?q={search_term_string}"},"query-input":"required name=search_term_string"}}]} {"@context":"https://schema.org","@type":"TechArticle","headline":"Run README.md in your terminal","url":"https://daily.dev/posts/run-readme-md-in-your-terminal-xrqhgkdgf","mainEntityOfPage":{"@type":"WebPage","@id":"https://daily.dev/posts/run-readme-md-in-your-terminal-xrqhgkdgf"},"datePublished":"2022-08-12T02:22:49.997Z","dateModified":"2023-12-07T12:02:45.284Z","description":"README is a markdown-based README.md file that lives in your repo’s version control. It has become part of modern development culture, and you will find them...","image":"https://media.daily.dev/image/upload/f_auto,q_auto/v1/posts/141a6802e1877af85ab154b59b77df2d","thumbnailUrl":"https://media.daily.dev/image/upload/f_auto,q_auto/v1/posts/141a6802e1877af85ab154b59b77df2d","isAccessibleForFree":true,"articleSection":"Community Picks","inLanguage":"en","publisher":{"@type":"Organization","name":"daily.dev","url":"https://daily.dev","logo":{"@type":"ImageObject","url":"https://daily.dev/apple-touch-icon.png","width":180,"height":180}},"author":{"@type":"Organization","name":"Community Picks","logo":"https://media.daily.dev/image/upload/t_logo,f_auto/v1655817725/logos/community","url":"https://daily.dev/sources/community"},"commentCount":3,"discussionUrl":"https://daily.dev/posts/run-readme-md-in-your-terminal-xrqhgkdgf","interactionStatistic":[{"@type":"InteractionCounter","interactionType":{"@type":"LikeAction"},"userInteractionCount":79},{"@type":"InteractionCounter","interactionType":{"@type":"CommentAction"},"userInteractionCount":3}],"keywords":"github,markdown","timeRequired":"PT3M"} {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https://daily.dev"},{"@type":"ListItem","position":2,"name":"Community Picks","item":"https://daily.dev/sources/community"},{"@type":"ListItem","position":3,"name":"Run README.md in your terminal"}]} {"@context":"https://schema.org","@type":"WebPage","@id":"https://daily.dev/posts/run-readme-md-in-your-terminal-xrqhgkdgf","comment":[{"@type":"Comment","text":"","datePublished":"2022-08-12T07:42:24.868Z","url":"https://daily.dev/posts/xRQhGkdgf#c-QiewxGBr0","author":{"@type":"Person","name":"Anth Rogan","url":"https://daily.dev/rogan","image":"https://avatars2.githubusercontent.com/u/30973884?v=4"},"interactionStatistic":{"@type":"InteractionCounter","interactionType":{"@type":"LikeAction"},"userInteractionCount":6}},{"@type":"Comment","text":"😎","datePublished":"2022-08-13T19:12:20.836Z","url":"https://daily.dev/posts/xRQhGkdgf#c-mkgn5LdbV","author":{"@type":"Person","name":"Bernard Huncho","url":"https://daily.dev/huncho254","image":"https://avatars.githubusercontent.com/u/87483225?v=4"}},{"@type":"Comment","text":"It seems so cool!","datePublished":"2022-08-12T08:11:04.337Z","url":"https://daily.dev/posts/xRQhGkdgf#c-j7R-UPK1k","author":{"@type":"Person","name":"DingRui Yang","url":"https://daily.dev/abser","image":"https://avatars.githubusercontent.com/u/32089134?v=4"}}]} ```