This repository has been archived by the owner on Aug 7, 2023. It is now read-only.
forked from decred/dcrd
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
multi: Update markdown files for GFM changes.
The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links and now requires a newline in between anchors and other formatting. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in some of the README.md files and correct some previous merge conflicts.
- Loading branch information
Showing
5 changed files
with
85 additions
and
1,298 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,6 +21,7 @@ | |
3. [The Decred-related Go Packages](#GoPackages) | ||
|
||
<a name="About" /> | ||
|
||
### 1. About | ||
dcrd is a full node decred implementation written in [Go](http://golang.org), | ||
licensed under the [copyfree](http://www.copyfree.org) ISC License. | ||
|
@@ -36,21 +37,25 @@ strict checks which filter transactions based on miner requirements ("standard" | |
transactions). | ||
|
||
<a name="GettingStarted" /> | ||
|
||
### 2. Getting Started | ||
|
||
<a name="Installation" /> | ||
|
||
**2.1 Installation**<br /> | ||
|
||
The first step is to install dcrd. See one of the following sections for | ||
details on how to install on the supported operating systems. | ||
|
||
<a name="WindowsInstallation" /> | ||
|
||
**2.1.1 Windows Installation**<br /> | ||
|
||
* Install the MSI available at: https://github.com/decred/dcrd/releases | ||
* Launch dcrd from the Start Menu | ||
|
||
<a name="PosixInstallation" /> | ||
|
||
**2.1.2 Linux/BSD/MacOSX/POSIX Installation**<br /> | ||
|
||
* Install Go according to the installation instructions here: http://golang.org/doc/install | ||
|
@@ -60,12 +65,14 @@ details on how to install on the supported operating systems. | |
* Run dcrd: `$ dcrd` | ||
|
||
<a name="Configuration" /> | ||
|
||
**2.2 Configuration**<br /> | ||
|
||
dcrd has a number of [configuration](http://godoc.org/github.com/decred/dcrd) | ||
options, which can be viewed by running: `$ dcrd --help`. | ||
|
||
<a name="DcrctlConfig" /> | ||
|
||
**2.3 Controlling and Querying dcrd via dcrctl**<br /> | ||
|
||
dcrctl is a command line utility that can be used to both control and query dcrd | ||
|
@@ -96,6 +103,7 @@ rpclimitpass=Limitedp4ssw0rd | |
For a list of available options, run: `$ dcrctl --help` | ||
|
||
<a name="Mining" /> | ||
|
||
**2.4 Mining**<br /> | ||
dcrd supports both the `getwork` and `getblocktemplate` RPCs although the | ||
`getwork` RPC is deprecated and will likely be removed in a future release. | ||
|
@@ -128,56 +136,68 @@ certificate into the default system Certificate Authority list. | |
`$ cgminer -o https://127.0.0.1:9109 -u rpcuser -p rpcpassword` | ||
|
||
<a name="Help" /> | ||
|
||
### 3. Help | ||
|
||
<a name="Startup" /> | ||
|
||
**3.1 Startup**<br /> | ||
|
||
Typically dcrd 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. | ||
|
||
<a name="BootstrapDat" /> | ||
|
||
**3.1.1 bootstrap.dat**<br /> | ||
* [Using bootstrap.dat](https://github.com/decred/dcrd/tree/master/docs/using_bootstrap_dat.md) | ||
|
||
<a name="NetworkConfig" /> | ||
|
||
**3.1.2 Network Configuration**<br /> | ||
* [What Ports Are Used by Default?](https://github.com/decred/dcrd/tree/master/docs/default_ports.md) | ||
* [How To Listen on Specific Interfaces](https://github.com/decred/dcrd/tree/master/docs/configure_peer_server_listen_interfaces.md) | ||
* [How To Configure RPC Server to Listen on Specific Interfaces](https://github.com/decred/dcrd/tree/master/docs/configure_rpc_server_listen_interfaces.md) | ||
* [Configuring dcrd with Tor](https://github.com/decred/dcrd/tree/master/docs/configuring_tor.md) | ||
|
||
<a name="Wallet" /> | ||
|
||
**3.1 Wallet**<br /> | ||
|
||
dcrd was intentionally developed without an integrated wallet for security | ||
reasons. Please see [dcrwallet](https://github.com/decred/dcrwallet) for more | ||
information. | ||
|
||
<a name="Contact" /> | ||
|
||
### 4. Contact | ||
|
||
<a name="ContactIRC" /> | ||
|
||
**4.1 IRC**<br /> | ||
* [irc.freenode.net](irc://irc.freenode.net), channel #dcrd | ||
|
||
<a name="MailingLists" /> | ||
|
||
**4.2 Mailing Lists**<br /> | ||
* <a href="mailto:[email protected]">dcrd</a>: discussion | ||
of dcrd and its packages. | ||
* <a href="mailto:[email protected]">dcrd-commits</a>: | ||
readonly mail-out of source code changes. | ||
|
||
<a name="DeveloperResources" /> | ||
|
||
### 5. Developer Resources | ||
|
||
<a name="ContributionGuidelines" /> | ||
|
||
* [Code Contribution Guidelines](https://github.com/decred/dcrd/tree/master/docs/code_contribution_guidelines.md) | ||
<a name="JSONRPCReference" /> | ||
|
||
* [JSON-RPC Reference](https://github.com/decred/dcrd/tree/master/docs/json_rpc_api.md) | ||
* [RPC Examples](https://github.com/decred/dcrd/tree/master/docs/json_rpc_api.md#ExampleCode) | ||
<a name="GoPackages" /> | ||
|
||
* The Decred-related Go Packages: | ||
* [dcrrpcclient](https://github.com/decred/dcrrpcclient) - Implements a | ||
robust and easy to use Websocket-enabled Decred JSON-RPC client | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.