#documentation
Bookmarked Writing a Damn Good README File
(flower.codes)
Raise your hand if you've ever read a README file. Now, keep that hand raised if you've ever written a README file. I'm going to take a shot in the dark and assume that your hand is still raised; at least, it's raised in spirit, since you probably refuse to flail your arms about like a crazy person just because I tell you to. After code comments, the README file is one of the most ubiquitous forms of documentation found in software development today. While not every source code repository has a README, it's a good bet that every successful one does.
_postfile
content
> Raise your hand if you've ever read a README file.
> Now, keep that hand raised if you've ever written a README file.
> I'm going to take a shot in the dark and assume that your hand is still raised; at least, it's raised in spirit, since you probably refuse to flail your arms about like a crazy person just because I tell you to.
> After code comments, the README file is one of the most ubiquitous forms of documentation found in software development today.
> While not every source code repository has a README, it's a good bet that every successful one does.
date
1671232684
day
17
description
> Raise your hand if you've ever read a README file.
> Now, keep that hand raised if you've ever written a README file.
> I'm going to take a shot in the dark and assume that your hand is still raised; at least, it's raised in spirit, since you probably refuse to flail your arms about like a crazy person just because I tell you to.
> After code comments, the README file is one of the most ubiquitous forms of documentation found in software development today.
> While not every source code repository has a README, it's a good bet that every successful one does.
domain
flower.codes
filename
2022-12-17-00:18:04.md
filepath
bookmarks
hour
00
link
http://flower.codes/2020/02/05/write-a-readme.html
minute
18
minutes_to_read
1
month
12
month_name
December
next
HASH(0x56026edc6f08)
prev
HASH(0x56026edccc80)
second
04
slug
00:18:04
sourcedir
posts/bookmarks/
tags
bookmarks, documentation, README
title
Writing a Damn Good README File
type
bookmark
url
/bookmarks/2022/12/17/001804/
url_name
index.html
url_path
/bookmarks/2022/12/17/001804
year
2022