LBRYCommunity/lbcd
1
0
Fork 0
Code Issues 17 Pull requests 4 Projects Releases 28 Packages Wiki Activity
lbcd/mining/cpuminer/README.md

26 lines
820 B
Markdown
Raw Permalink Normal View History

cpuminer: Refactor code to its own package. 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
2016-10-28 18:06:11 +02:00
cpuminer
========
[lbry] docs: update docs for LBRY Co-authored-by: Roy Lee <roylee17@gmail.com>
2021-08-19 20:41:48 +02:00
[![Build Status](https://github.com/lbryio/lbcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/lbryio/lbcd/actions)
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.
2017-05-25 18:29:23 +02:00
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[lbry] docs: update docs for LBRY Co-authored-by: Roy Lee <roylee17@gmail.com>
2021-08-19 20:41:48 +02:00
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/lbryio/lbcd/mining/cpuminer)
multi: update to point to roasbeef forks
2017-08-25 01:29:38 +02:00
=======
cpuminer: Refactor code to its own package. 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
2016-10-28 18:06:11 +02:00
## 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
[lbry] docs: update docs for LBRY Co-authored-by: Roy Lee <roylee17@gmail.com>
2021-08-19 20:41:48 +02:00
$ go get -u github.com/lbryio/lbcd/mining/cpuminer
cpuminer: Refactor code to its own package. 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
2016-10-28 18:06:11 +02:00
```
## License
Package cpuminer is licensed under the [copyfree](http://copyfree.org) ISC
License.
Reference in a new issue Copy permalink