update and reformat README.md #2102

pull colindean wants to merge 1 commits into bitcoin:master from colindean:doc/root-readme changing 2 files +50 −30

colindean commented at 2:34 AM on December 13, 2012: contributor
- updated references to files which have since been moved
- added reference to licensing
- added brief summary in case a non-technical user happens upon repo first
- miscellaneous Markdown-isms to make the doc more attractive
- remove unused symlink README -> README.md
I double-checked the makefiles and whatnot to ensure that the README symlink is not being referenced. It is not. Rather, doc/README and doc/README_windows.txt are copied for distribution.

update and reformat README.md

* updated references to files which have since been moved
* added reference to licensing
* added brief summary in case a non-technical user happens upon repo first
* miscellaneous Markdown-isms to make the doc more attractive
* remove unused symlink README -> README.md

I double-checked the makefiles and whatnot to ensure that the README symlink is
not being referenced. It is not. Rather, `doc/README` and
`doc/README_windows.txt` are copied for distribution.

67068a13ec

gavinandresen commented at 7:46 PM on December 13, 2012: contributor

ACK
colindean commented at 8:24 PM on December 13, 2012: contributor

Anything else that you'd like to see changed or added in it?
gavinandresen commented at 10:10 PM on December 13, 2012: contributor

"ACK" means "acknowledged, looks good"

The QA information is obsolete, but I think we should pull your changes and then make further edits.
colindean commented at 11:35 PM on December 13, 2012: contributor

Sounds great.
BitcoinPullTester commented at 2:48 AM on December 16, 2012: none

Automatic sanity-testing: PASSED, see http://jenkins.bluematt.me/pull-tester/67068a13ec07e89c8a0c95be209ea54570066806 for binaries and test log.
sipa commented at 5:40 PM on December 25, 2012: member

ACK
Diapolo commented at 2:03 AM on January 1, 2013: none

ACK
gavinandresen commented at 8:12 PM on January 14, 2013: contributor

Sorry, I forgot this pull request existed when I rewrote the README.md a little while ago.

Closing this, because at this point it should be easier to start from the README.md in the tree rather than this pull.
gavinandresen closed this on Jan 14, 2013
colindean commented at 5:22 AM on January 17, 2013: contributor

Alrighty. I'll try to get to it at some point in the next day or two.
HashUnlimited referenced this in commit 4a049d649d on Jun 11, 2018
DrahtBot locked this on Sep 8, 2021

Contributors

Linked (view graph)

#2250 update and reformat README.md