update and reformat README.md #2102

Closed
wants to merge 1 commit into
from

Projects

None yet

5 participants

@colindean
  • 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.

@colindean colindean 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.
67068a1
@gavinandresen
Bitcoin member

ACK

@colindean

Anything else that you'd like to see changed or added in it?

@gavinandresen
Bitcoin member

"ACK" means "acknowledged, looks good"

The QA information is obsolete, but I think we should pull your changes and then make further edits.

@colindean
@BitcoinPullTester

Automatic sanity-testing: PASSED, see http://jenkins.bluematt.me/pull-tester/67068a13ec07e89c8a0c95be209ea54570066806 for binaries and test log.

@sipa
Bitcoin member

ACK

@Diapolo

ACK

@gavinandresen
Bitcoin member

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.

@colindean

Alrighty. I'll try to get to it at some point in the next day or two.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment