xmrig/README.md

# XMRig

[![Github All Releases](https://img.shields.io/github/downloads/xmrig/xmrig/total.svg)](https://github.com/xmrig/xmrig/releases)
[![GitHub release](https://img.shields.io/github/release/xmrig/xmrig/all.svg)](https://github.com/xmrig/xmrig/releases)
[![GitHub Release Date](https://img.shields.io/github/release-date/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/releases)
[![GitHub license](https://img.shields.io/github/license/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/blob/master/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/network)

XMRig is a high performance, open source, cross platform RandomX, KawPow, CryptoNight, AstroBWT and [GhostRider](https://github.com/xmrig/xmrig/tree/master/src/crypto/ghostrider#readme) unified CPU/GPU miner and [RandomX benchmark](https://xmrig.com/benchmark). Official binaries are available for Windows, Linux, macOS and FreeBSD.

## Mining backends
- **CPU** (x64/ARMv8)
- **OpenCL** for AMD GPUs.
- **CUDA** for NVIDIA GPUs via external [CUDA plugin](https://github.com/xmrig/xmrig-cuda).

## Download
* **[Binary releases](https://github.com/xmrig/xmrig/releases)**
* **[Build from source](https://xmrig.com/docs/miner/build)**

## Usage
The preferred way to configure the miner is the [JSON config file](https://xmrig.com/docs/miner/config) as it is more flexible and human friendly. The [command line interface](https://xmrig.com/docs/miner/command-line-options) does not cover all features, such as mining profiles for different algorithms. Important options can be changed during runtime without miner restart by editing the config file or executing [API](https://xmrig.com/docs/miner/api) calls.

* **[Wizard](https://xmrig.com/wizard)** helps you create initial configuration for the miner.
* **[Workers](http://workers.xmrig.info)** helps manage your miners via HTTP API.

## Donations
* Default donation 1% (1 minute in 100 minutes) can be increased via option `donate-level` or disabled in source code.
* XMR: `48edfHu7V9Z84YzzMa6fUueoELZ9ZRXq9VetWzYGzKt52XU5xvqgzYnDK9URnRoJMk1j8nLwEVsaSWJ4fhdUyZijBGUicoD`

## Developers
* **[xmrig](https://github.com/xmrig)**
* **[sech1](https://github.com/SChernykh)**

## Contacts
* support@xmrig.com
* [reddit](https://www.reddit.com/user/XMRig/)
* [twitter](https://twitter.com/xmrig_dev)
Initial import. 2017-04-15 06:02:08 +00:00			`# XMRig`
Update README.md 2018-03-14 18:32:09 +00:00
Update README.md 2018-02-01 22:14:39 +00:00			`[![Github All Releases](https://img.shields.io/github/downloads/xmrig/xmrig/total.svg)](https://github.com/xmrig/xmrig/releases)`
Update README.md 2018-02-01 22:58:11 +00:00			`[![GitHub release](https://img.shields.io/github/release/xmrig/xmrig/all.svg)](https://github.com/xmrig/xmrig/releases)`
Update README.md 2020-08-26 16:09:05 +00:00			`[![GitHub Release Date](https://img.shields.io/github/release-date/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/releases)`
Update README.md 2018-02-01 22:14:39 +00:00			`[![GitHub license](https://img.shields.io/github/license/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/blob/master/LICENSE)`
			`[![GitHub stars](https://img.shields.io/github/stars/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/stargazers)`
			`[![GitHub forks](https://img.shields.io/github/forks/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/network)`

Update README.md 2021-12-19 15:26:50 +00:00			`XMRig is a high performance, open source, cross platform RandomX, KawPow, CryptoNight, AstroBWT and [GhostRider](https://github.com/xmrig/xmrig/tree/master/src/crypto/ghostrider#readme) unified CPU/GPU miner and [RandomX benchmark](https://xmrig.com/benchmark). Official binaries are available for Windows, Linux, macOS and FreeBSD.`
Update README.md 2019-11-01 21:03:03 +00:00
			`## Mining backends`
Update README.md 2020-08-26 16:09:05 +00:00			`- CPU (x64/ARMv8)`
Update README.md 2019-11-01 21:03:03 +00:00			`- OpenCL for AMD GPUs.`
			`- CUDA for NVIDIA GPUs via external [CUDA plugin](https://github.com/xmrig/xmrig-cuda).`
Update README.md 2017-08-20 06:48:31 +00:00
Initial import. 2017-04-15 06:02:08 +00:00			`## Download`
Update README.md 2020-08-26 16:09:05 +00:00			`* [Binary releases](https://github.com/xmrig/xmrig/releases)`
			`* [Build from source](https://xmrig.com/docs/miner/build)`
Initial import. 2017-04-15 06:02:08 +00:00
			`## Usage`
v6.9.0-dev 2021-02-20 07:28:20 +00:00			`The preferred way to configure the miner is the [JSON config file](https://xmrig.com/docs/miner/config) as it is more flexible and human friendly. The [command line interface](https://xmrig.com/docs/miner/command-line-options) does not cover all features, such as mining profiles for different algorithms. Important options can be changed during runtime without miner restart by editing the config file or executing [API](https://xmrig.com/docs/miner/api) calls.`
Update README.md 2017-07-02 19:21:29 +00:00
Update README.md 2020-08-26 16:09:05 +00:00			`* [Wizard](https://xmrig.com/wizard) helps you create initial configuration for the miner.`
			`* [Workers](http://workers.xmrig.info) helps manage your miners via HTTP API.`
Initial import. 2017-04-15 06:02:08 +00:00
Update README.md. 2017-04-15 06:46:16 +00:00			`## Donations`
Update README.md 2020-08-20 06:44:20 +00:00			* Default donation 1% (1 minute in 100 minutes) can be increased via option `donate-level` or disabled in source code.
Update README.md. 2017-04-15 06:46:16 +00:00			* XMR: `48edfHu7V9Z84YzzMa6fUueoELZ9ZRXq9VetWzYGzKt52XU5xvqgzYnDK9URnRoJMk1j8nLwEVsaSWJ4fhdUyZijBGUicoD`
Update README.md 2020-08-26 16:09:05 +00:00
			`## Developers`
			`* [xmrig](https://github.com/xmrig)`
			`* [sech1](https://github.com/SChernykh)`
Update README.md 2017-04-21 09:34:59 +00:00
			`## Contacts`
			`* support@xmrig.com`
			`* [reddit](https://www.reddit.com/user/XMRig/)`
Update README.md 2018-10-01 10:36:03 +00:00			`* [twitter](https://twitter.com/xmrig_dev)`