Skip to content
This repository has been archived by the owner on Aug 7, 2023. It is now read-only.

Commit

Permalink
multi: Update markdown files for GFM changes.
Browse files Browse the repository at this point in the history
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
davecgh committed Jul 16, 2017
1 parent ea5dc78 commit e2b74d5
Show file tree
Hide file tree
Showing 5 changed files with 85 additions and 1,298 deletions.
20 changes: 7 additions & 13 deletions dcrec/secp256k1/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
secp256k1
=====

[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)]
(https://travis-ci.org/decred/dcrd) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/decred/dcrd/dcrec/secp256k1)
[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)](https://travis-ci.org/decred/dcrd)
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/decred/dcrd/dcrec/secp256k1)

Package dcrec implements elliptic curve cryptography needed for working with
Decred (secp256k1 only for now). It is designed so that it may be used with the
Expand All @@ -27,23 +25,19 @@ $ go get -u github.com/decred/dcrd/dcrec

## Examples

* [Sign Message]
(http://godoc.org/github.com/decred/dcrd/dcrec#example-package--SignMessage)
* [Sign Message](http://godoc.org/github.com/decred/dcrd/dcrec#example-package--SignMessage)
Demonstrates signing a message with a secp256k1 private key that is first
parsed form raw bytes and serializing the generated signature.

* [Verify Signature]
(http://godoc.org/github.com/decred/dcrd/dcrec#example-package--VerifySignature)
* [Verify Signature](http://godoc.org/github.com/decred/dcrd/dcrec#example-package--VerifySignature)
Demonstrates verifying a secp256k1 signature against a public key that is
first parsed from raw bytes. The signature is also parsed from raw bytes.

* [Encryption]
(http://godoc.org/github.com/decred/dcrd/dcrec#example-package--EncryptMessage)
* [Encryption](http://godoc.org/github.com/decred/dcrd/dcrec#example-package--EncryptMessage)
Demonstrates encrypting a message for a public key that is first parsed from
raw bytes, then decrypting it using the corresponding private key.

* [Decryption]
(http://godoc.org/github.com/decred/dcrdy/dcrec#example-package--DecryptMessage)
* [Decryption](http://godoc.org/github.com/decred/dcrdy/dcrec#example-package--DecryptMessage)
Demonstrates decrypting a message using a private key that is first parsed
from raw bytes.

Expand Down
20 changes: 20 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
15 changes: 15 additions & 0 deletions docs/code_contribution_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
6.2. [Licensing of Contributions](#Licensing)<br />

<a name="Overview" />

### 1. Overview

Developing cryptocurrencies is an exciting endeavor that touches a wide variety
Expand All @@ -38,6 +39,7 @@ We highly encourage code contributions, however it is imperative that you adhere
to the guidelines established on this page.

<a name="MinSkillset" />

### 2. Minimum Recommended Skillset

The following list is a set of core competencies that we recommend you possess
Expand All @@ -63,6 +65,7 @@ understanding of the various aspects involved with cryptography such as the
security and performance implications.

<a name="ReqReading" />

### 3. Required Reading

- [Effective Go](http://golang.org/doc/effective_go.html) - The entire dcrd
Expand All @@ -72,13 +75,15 @@ security and performance implications.
foundation to build on will make the code much more comprehensible.

<a name="DevelopmentPractices" />

### 4. Development Practices

Developers are expected to work in their own trees and submit pull requests when
they feel their feature or bug fix is ready for integration into the master
branch.

<a name="ShareEarly" />

### 4.1 Share Early, Share Often

We firmly believe in the share early, share often approach. The basic premise
Expand All @@ -101,6 +106,7 @@ This approach has several benefits:
spend rebasing and otherwise trying to keep up with the main code base

<a name="Testing" />

### 4.2 Testing

One of the major design goals of all core dcrd packages is to aim for complete
Expand All @@ -127,6 +133,7 @@ A quick summary of test practices follows:
to both prove it has been resolved and to prevent future regressions

<a name="CodeDocumentation" />

### 4.3 Code Documentation and Commenting

- At a minimum every function must be commented with its intended purpose and
Expand Down Expand Up @@ -196,6 +203,7 @@ but it was left as a magic number to show how much of a difference a good
comment can make.
<a name="ModelGitCommitMessages" />
### 4.4 Code Documentation and Commenting
This project prefers to keep a clean commit history with well-formed commit
Expand Down Expand Up @@ -242,12 +250,14 @@ a good thing.
reply indicators without overflow in an 80 column terminal.
<a name="CodeApproval" />
### 5. Code Approval Process
This section describes the code approval process that is used for code
contributions. This is how to get your changes into dcrd.
<a name="CodeReview" />
### 5.1 Code Review
All code which is submitted will need to be reviewed before inclusion into the
Expand Down Expand Up @@ -283,6 +293,7 @@ checks which are generally performed as follows:
consensus
<a name="CodeRework" />
### 5.2 Rework Code (if needed)
After the code review, the change will be accepted immediately if no issues are
Expand All @@ -295,6 +306,7 @@ make the necessary changes.
This process will continue until the code is finally accepted.
<a name="CodeAcceptance" />
### 5.3 Acceptance
Once your code is accepted, it will be integrated with the master branch.
Expand All @@ -306,9 +318,11 @@ the master branch and the pull request will be closed.
Rejoice as you will now be listed as a [contributor](https://github.com/decred/dcrd/graphs/contributors)!
<a name="Standards" />
### 6. Contribution Standards
<a name="Checklist" />
### 6.1. Contribution Checklist
- [&nbsp;&nbsp;] All changes are Go version 1.3 compliant
Expand All @@ -327,6 +341,7 @@ Rejoice as you will now be listed as a [contributor](https://github.com/decred/d
report any **new** issues that did not already exist
<a name="Licensing" />
### 6.2. Licensing of Contributions
****
All contributions must be licensed with the
Expand Down
Loading

0 comments on commit e2b74d5

Please sign in to comment.