github.com/btcsuite/btcd@v0.24.0/mining/cpuminer/README.md (about)

     1  cpuminer
     2  ========
     3  
     4  [![Build Status](https://github.com/btcsuite/btcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcd/actions)
     5  [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
     6  [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/btcsuite/btcd/mining/cpuminer)
     7  =======
     8  
     9  ## Overview
    10  
    11  This package is currently a work in progress.  It works without issue since it
    12  is used in several of the integration tests, but the API is not really ready for
    13  public consumption as it has simply been refactored out of the main codebase for
    14  now.
    15  
    16  ## Installation and Updating
    17  
    18  ```bash
    19  $ go get -u github.com/btcsuite/btcd/mining/cpuminer
    20  ```
    21  
    22  ## License
    23  
    24  Package cpuminer is licensed under the [copyfree](http://copyfree.org) ISC
    25  License.