1a69eb0617
This does the minimum work necessary to refactor the CPU miner code into its own package. The idea is that separating this code into its own package will improve its testability and ultimately be useful to other parts of the codebase such as the various tests which currently effectively have their own stripped-down versions of this code. The API will certainly need some additional cleanup and changes to make it more usable outside of the specific circumstances it was originally designed to support (namely the generate RPC), however it is better to do that in future commits in order to keep the changeset as small as possible during this refactor. Overview of the major changes: - Create the new package - Move cpuminer.go -> cpuminer/cpuminer.go - Update mining logging to use the new cpuminer package logger - Rename cpuminerConfig to Config (so it's now cpuminer.Config) - Rename newCPUMiner to New (so it's now cpuminer.New) - Update all references to the cpuminer to use the package - Add a skeleton README.md
26 lines
791 B
Markdown
26 lines
791 B
Markdown
cpuminer
|
|
========
|
|
|
|
[]
|
|
(https://travis-ci.org/btcsuite/btcd) [![ISC License]
|
|
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
|
[]
|
|
(http://godoc.org/github.com/btcsuite/btcd/mining/cpuminer)
|
|
|
|
## Overview
|
|
|
|
This package is currently a work in progress. It works without issue since it
|
|
is used in several of the integration tests, but the API is not really ready for
|
|
public consumption as it has simply been refactored out of the main codebase for
|
|
now.
|
|
|
|
## Installation and Updating
|
|
|
|
```bash
|
|
$ go get -u github.com/btcsuite/btcd/mining/cpuminer
|
|
```
|
|
|
|
## License
|
|
|
|
Package cpuminer is licensed under the [copyfree](http://copyfree.org) ISC
|
|
License.
|