search

EAWF / BTC-Toolbox

A collection of simple programming tools to aid entities in the action of accepting BTC payments directly to HD Wallets within their control.
The Unlicense
9 stars 6 forks source link

Update README.md #34

Closed EAWF closed 4 years ago

EAWF commented 4 years ago

NOTE: Since you're using the shortcuts at the bottom, it's not necessary to use the [getBTCAddress][getBTCAddress] format and instead can simply use [getBTCAddress] for those links. See the link for [getBTC.conf] in the table of contents. Great idea for doing that. I think we have to do the same on every page so that there is consistency. Easy enough to do. REALLY nice looking now.

Will need to go through all the files and clean those up...but great widget to use...keeps page cleaner.

Septem151 commented 4 years ago

Is it necessary to include: "Download the getBTC.conf file"

When there's a section right there that says 'The configuration file must be named getBTC.conf. For an example configuration file, see getBTC.conf."? It's not necessary that they download the getBTC.conf file, only that they have one that follows the format.

Also getBTC.conf is a helper file, not a README.md page, so I don't think it should be included in the Table of Contents since it's not a "section". Just my thoughts.

EAWF commented 4 years ago

It's kind of a section. It's easy enough to include it and won't mess things up. getBTCAddress is going to require it, and getBTCInvoice is going to call getBTCAddress to get an address. I added in the "Default" account name to make single extended pubkey users not have to think about the need for the account name.

I'm also thinking that the repo will most likely be the thing that people use as a reference for how to fix something that they probably screwed up, so having it in the TOC and having a page for it makes sense.

On 2020-08-23 20:34, Carson Mullins wrote:

Is it necessary to include: "Download the getBTC.conf file"

When there's a section right there that says 'The configuration file must be named getBTC.conf. For an example configuration file, see getBTC.conf."? It's not necessary that they download the getBTC.conf file, only that they have one that follows the format.

Also getBTC.conf is a helper file, not a README.md page, so I don't think it should be included in the Table of Contents since it's not a "section". Just my thoughts.

-- You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub [1], or unsubscribe [2].

Links:

[1] https://github.com/EAWF/Bitcoin-Merchants-Toolbox/pull/34#issuecomment-678885758 [2] https://github.com/notifications/unsubscribe-auth/AEXMNYO7IPPDI766I7UYUV3SCHNUJANCNFSM4QJBHR4A

EAWF commented 4 years ago

Is it necessary to include: "Download the getBTC.conf file"

No, but we can include it into the downloadable package for each language.

Also getBTC.conf is a helper file, not a README.md page, so I don't think it should be included in the Table of Contents since it's not a "section".

True, but as a programmer, if I screw up my copy, it's nice to be able to visit the source repo and cut and paste a working copy., PLUS, it's good to have easy to reach documentation on the repo.