Root and /Doc Readme Cleanup. #2902

super3 commented at 6:40 PM on August 15, 2013: contributor

Clickable links in main README Added some notes and mac instructions to /doc README Added Bitcoin API commands for quick developer reference.

Root and /Doc Readme Cleanup.

Clickable links in main README
Added some notes and mac instructions to /doc README
Added Bitcoin API commands for quick developer reference.

0f1e683539

URL Typo 52c61a28f3

Diapolo commented at 6:53 PM on August 15, 2013: none

I agree with @petertodd here, it's hard enough sometimes to remind devs to add new options in the help message in the code ^^.

Michagogo commented at 6:55 PM on August 15, 2013: contributor

I think I also agree with petertodd and Diapolo -- I've seen this stuff be out of date in other places, such as the wiki, and I think that in this case it's best to simply direct users to one central place.

super3 commented at 6:56 PM on August 15, 2013: contributor

Figured that would be a point. As a developer I though it would be helpful to have the API commands in file, so I could load them up in my editor. But I see what you are saying on how the probably will not get updated as they should.

I think I will make it a shortlist instead with the most important commands with some explanation. And have them -? and google the rest.

Michagogo commented at 6:58 PM on August 15, 2013: contributor

@super3 If you want to have the commands in a list, it's as simple as bitcoind --help >> switches for the command line switches, or bitcoind help >> commands for the RPC commands.

super3 commented at 7:00 PM on August 15, 2013: contributor

@Michagogo Well the plan was to go a little further than just listing them, but providing examples of usage as well. Should that be thrown into the /docs or the wiki or both?

Michagogo commented at 7:09 PM on August 15, 2013: contributor

Oops, didn't know those comments would actually post to the PR.

BitcoinPullTester commented at 7:13 PM on August 15, 2013: none

Automatic sanity-testing: PASSED, see http://jenkins.bluematt.me/pull-tester/52c61a28f383c4aa936d8912b2064be8f30a38a5 for binaries and test log. This test script verifies pulls every time they are updated. It, however, dies sometimes and fails to test properly. If you are waiting on a test, please check timestamps to verify that the test.log is moving at http://jenkins.bluematt.me/pull-tester/current/ Contact BlueMatt on freenode if something looks broken.

Slight improvement based on feedback. 64168b58b2

super3 commented at 7:44 PM on August 15, 2013: contributor

Should be a little bit better now.

BitcoinPullTester commented at 8:41 PM on August 15, 2013: none

Automatic sanity-testing: PASSED, see http://jenkins.bluematt.me/pull-tester/64168b58b26ee152f944118ff70fc60f671d2ea9 for binaries and test log. This test script verifies pulls every time they are updated. It, however, dies sometimes and fails to test properly. If you are waiting on a test, please check timestamps to verify that the test.log is moving at http://jenkins.bluematt.me/pull-tester/current/ Contact BlueMatt on freenode if something looks broken.

gavinandresen commented at 9:45 PM on August 15, 2013: contributor

Agreed that running_bitcoin.md is a bad idea; just direct people to the command-line help and the wiki (having two places that are always out of date is better than three).

in README.md:None in 64168b58b2 outdated

  11 | @@ -12,16 +12,15 @@ Bitcoin is an experimental new digital currency that enables instant payments to
  12 |  anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate
  13 |  with no central authority: managing transactions and issuing money are carried
  14 |  out collectively by the network. Bitcoin is also the name of the open source
  15 | -software which enables the use of this currency.
  16 | +software which enables the use of this currency.

Diapolo commented at 5:49 AM on August 16, 2013:

That space seems unneeded and rather ugly ^^.

in doc/README.md:None in 64168b58b2 outdated

   8 | +---------------------
   9 |  Distributed under the [MIT/X11 software license](http://www.opensource.org/licenses/mit-license.php).
  10 |  This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](http://www.openssl.org/). This product includes
  11 |  cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.
  12 |  
  13 | -

fanquake commented at 8:14 AM on August 16, 2013:

Curious as to why your dropping the intro?

super3 commented at 12:56 PM on August 20, 2013:

"What is Bitcoin?" in the root does a good job of that. If there does need to be an intro there, I think it should be more of a technical summary of the Bitcoin paper.

On Fri, Aug 16, 2013 at 4:14 AM, Michael Ford notifications@github.comwrote:

In doc/README.md:

Distributed under the MIT/X11 software license. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com), and UPnP software written by Thomas Bernard.

Curious as to why your dropping the intro?

— Reply to this email directly or view it on GitHubhttps://github.com/bitcoin/bitcoin/pull/2902/files#r5809365 .

Shawn Wilkinson Student, Morehouse College Independent Web Developer me@super3.org http://super3.org

in README.md:None in 64168b58b2 outdated

   0 | @@ -1,7 +1,7 @@
   1 |  Bitcoin integration/staging tree
   2 |  ================================
   3 |  
   4 | -http://www.bitcoin.org
   5 | +[http://www.bitcoin.org](http://www.bitcoin.org)

luke-jr commented at 12:41 PM on August 20, 2013:

Does markdown not infer URLs?

With this amount of ugliness, might as well use straight HTML... the point of markdown is to still look nice as plain text, right?

petertodd commented at 12:45 PM on August 20, 2013:

Gah, I'd much rather live with having to cut-n-paste in the extremely unlikely chance i actually want to click on bitcoin.org...

IMO just leave it as "http://www.bitcoin.org", who cares if some readers don't see the URL?

super3 commented at 1:01 PM on August 20, 2013:

Unfortunately not. I don't think its too bad, but then again I'm writing it so I come with a bias. You are kinda right. It would be nice to have some Sphinx like docs.

On Tue, Aug 20, 2013 at 8:41 AM, Luke-Jr notifications@github.com wrote:

In README.md:

@@ -1,7 +1,7 @@ Bitcoin integration/staging tree

-http://www.bitcoin.org +http://www.bitcoin.org

Does markdown not infer URLs?

With this amount of ugliness, might as well use straight HTML... the point of markdown is to still look nice as plain text, right?

— Reply to this email directly or view it on GitHubhttps://github.com/bitcoin/bitcoin/pull/2902/files#r5867096 .

Shawn Wilkinson Student, Morehouse College Independent Web Developer me@super3.org http://super3.org

super3 commented at 1:09 PM on August 20, 2013:

I linkified that stuff more for the people who are browsing through on Github. Should I change the external links back? The relative repo links are fine, but you and @Luke-Jr don't seems to like the external ones.

Wish I knew more about usage of the actual docs, so I know if I need to cater to nice Github renderings of markdown, or people actually loading up the raw file in an editor.

On Tue, Aug 20, 2013 at 8:45 AM, Peter Todd notifications@github.comwrote:

In README.md:

@@ -1,7 +1,7 @@ Bitcoin integration/staging tree

-http://www.bitcoin.org +http://www.bitcoin.org

Gah, I'd much rather live with having to cut-n-paste in the extremely unlikely chance i actually want to click on bitcoin.org...

— Reply to this email directly or view it on GitHubhttps://github.com/bitcoin/bitcoin/pull/2902/files#r5867166 .

Shawn Wilkinson Student, Morehouse College Independent Web Developer me@super3.org http://super3.org

petertodd commented at 1:29 PM on August 20, 2013:

Yeah, I'd change them back - on most browsers you can select text and right-click to open the link anyway.

I'd guess people reading it on github vs. people reading it in an editor is about 50:50, so don't optimize one at the expense of another. That's why we're using markdown after all.

super3 commented at 2:02 PM on August 20, 2013:

Fair enough. Probably need to poll some devs at some point for future reference.

@Diapolo and @petertodd Suggestions. d9a4c6fa92

BitcoinPullTester commented at 1:45 AM on August 27, 2013: none

Automatic sanity-testing: PASSED, see http://jenkins.bluematt.me/pull-tester/d9a4c6fa92e26785d124066de8df5b3ef9ac0d7a for binaries and test log. This test script verifies pulls every time they are updated. It, however, dies sometimes and fails to test properly. If you are waiting on a test, please check timestamps to verify that the test.log is moving at http://jenkins.bluematt.me/pull-tester/current/ Contact BlueMatt on freenode if something looks broken.

Diapolo commented at 1:26 PM on August 29, 2013: none

You should squash into a single commit. I have no big tendendy towards or against this pull, it's fine to merge it from my side.

super3 commented at 2:25 PM on October 12, 2013: contributor

Too minor of a change to do a pull. Closing and will add the good stuff to my next pull request.

super3 closed this on Oct 12, 2013

IntegralTeam referenced this in commit b63f7dd39a on Jun 4, 2019

DrahtBot locked this on Sep 8, 2021