From 2a01456189ae90c6d3afb17e1b1e80af85a5bd0d Mon Sep 17 00:00:00 2001 From: esemplastic Date: Wed, 3 May 2017 18:59:47 +0000 Subject: [PATCH] Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks. --- docs/README.md | 77 +++++++++++++++++++++++++++++++++++--------------- 1 file changed, 54 insertions(+), 23 deletions(-) diff --git a/docs/README.md b/docs/README.md index 838b286b..3dc06774 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,7 +22,9 @@ 3. [The btcsuite Bitcoin-related Go Packages](#GoPackages) + ### 1. About + btcd is a full node bitcoin implementation written in [Go](http://golang.org), licensed under the [copyfree](http://www.copyfree.org) ISC License. @@ -53,22 +55,27 @@ directly with btcd. That functionality is provided by the which are both under active development. + ### 2. Getting Started -**2.1 Installation**
+ +**2.1 Installation** The first step is to install btcd. See one of the following sections for details on how to install on the supported operating systems. + **2.1.1 Windows Installation**
* Install the MSI available at: https://github.com/btcsuite/btcd/releases * Launch btcd from the Start Menu -**2.1.2 Linux/BSD/MacOSX/POSIX Installation**
+ +**2.1.2 Linux/BSD/MacOSX/POSIX Installation** + - Install Go according to the installation instructions here: http://golang.org/doc/install @@ -110,7 +117,8 @@ $ go install . ./cmd/... ``` -**2.1.2.1 Gentoo Linux Installation**
+ +**2.1.2.1 Gentoo Linux Installation** * Install Layman and enable the Bitcoin overlay. * https://gitlab.com/bitcoin/gentoo @@ -118,13 +126,15 @@ $ go install . ./cmd/... * Install btcd: `$ emerge net-p2p/btcd` -**2.2 Configuration**
+ +**2.2 Configuration** btcd has a number of [configuration](http://godoc.org/github.com/btcsuite/btcd) options, which can be viewed by running: `$ btcd --help`. -**2.3 Controlling and Querying btcd via btcctl**
+ +**2.3 Controlling and Querying btcd via btcctl** btcctl is a command line utility that can be used to both control and query btcd via [RPC](http://www.wikipedia.org/wiki/Remote_procedure_call). btcd does @@ -154,11 +164,14 @@ rpclimitpass=Limitedp4ssw0rd For a list of available options, run: `$ btcctl --help` -**2.4 Mining**
-btcd supports the `getblocktemplate` RPC. -The limited user cannot access this RPC.
-**1. Add the payment addresses with the `miningaddr` option.**
+**2.4 Mining** + +btcd supports the `getblocktemplate` RPC. +The limited user cannot access this RPC. + + +**1. Add the payment addresses with the `miningaddr` option.** ``` [Application Options] @@ -168,73 +181,91 @@ miningaddr=12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX miningaddr=1M83ju3EChKYyysmM2FXtLNftbacagd8FR ``` -**2. Add btcd's RPC TLS certificate to system Certificate Authority list.**
+**2. Add btcd's RPC TLS certificate to system Certificate Authority list.** `cgminer` uses [curl](http://curl.haxx.se/) to fetch data from the RPC server. Since curl validates the certificate by default, we must install the `btcd` RPC certificate into the default system Certificate Authority list. -**Ubuntu**
+**Ubuntu** -1. Copy rpc.cert to /usr/share/ca-certificates: `# cp /home/user/.btcd/rpc.cert /usr/share/ca-certificates/btcd.crt`
-2. Add btcd.crt to /etc/ca-certificates.conf: `# echo btcd.crt >> /etc/ca-certificates.conf`
-3. Update the CA certificate list: `# update-ca-certificates`
+1. Copy rpc.cert to /usr/share/ca-certificates: `# cp /home/user/.btcd/rpc.cert /usr/share/ca-certificates/btcd.crt` +2. Add btcd.crt to /etc/ca-certificates.conf: `# echo btcd.crt >> /etc/ca-certificates.conf` +3. Update the CA certificate list: `# update-ca-certificates` -**3. Set your mining software url to use https.**
+**3. Set your mining software url to use https.** `$ cgminer -o https://127.0.0.1:8334 -u rpcuser -p rpcpassword` + ### 3. Help -**3.1 Startup**
+ +**3.1 Startup** Typically btcd will run and start downloading the block chain with no extra configuration necessary, however, there is an optional method to use a `bootstrap.dat` file that may speed up the initial block chain download process. -**3.1.1 bootstrap.dat**
-* [Using bootstrap.dat](https://github.com/btcsuite/btcd/tree/master/docs/using_bootstrap_dat.md) +**3.1.1 bootstrap.dat** + +* [Using bootstrap.dat](https://github.com/btcsuite/btcd/tree/master/docs/using_bootstrap_dat.md) -**3.1.2 Network Configuration**
+ +**3.1.2 Network Configuration** + * [What Ports Are Used by Default?](https://github.com/btcsuite/btcd/tree/master/docs/default_ports.md) * [How To Listen on Specific Interfaces](https://github.com/btcsuite/btcd/tree/master/docs/configure_peer_server_listen_interfaces.md) * [How To Configure RPC Server to Listen on Specific Interfaces](https://github.com/btcsuite/btcd/tree/master/docs/configure_rpc_server_listen_interfaces.md) * [Configuring btcd with Tor](https://github.com/btcsuite/btcd/tree/master/docs/configuring_tor.md) -**3.1 Wallet**
+ +**3.1 Wallet** btcd was intentionally developed without an integrated wallet for security reasons. Please see [btcwallet](https://github.com/btcsuite/btcwallet) for more information. + + ### 4. Contact -**4.1 IRC**
-* [irc.freenode.net](irc://irc.freenode.net), channel #btcd + +**4.1 IRC** + +* [irc.freenode.net](irc://irc.freenode.net), channel `#btcd` -**4.2 Mailing Lists**
+ +**4.2 Mailing Lists** + * btcd: discussion of btcd and its packages. * btcd-commits: readonly mail-out of source code changes. + ### 5. Developer Resources + * [Code Contribution Guidelines](https://github.com/btcsuite/btcd/tree/master/docs/code_contribution_guidelines.md) + + * [JSON-RPC Reference](https://github.com/btcsuite/btcd/tree/master/docs/json_rpc_api.md) * [RPC Examples](https://github.com/btcsuite/btcd/tree/master/docs/json_rpc_api.md#ExampleCode) + + * The btcsuite Bitcoin-related Go Packages: * [btcrpcclient](https://github.com/btcsuite/btcrpcclient) - Implements a robust and easy to use Websocket-enabled Bitcoin JSON-RPC client