rig/README.md

40 lines
2.4 KiB
Markdown
Raw Normal View History

2017-04-15 09:02:08 +03:00
# XMRig
2018-03-15 01:32:09 +07:00
2018-02-02 00:14:39 +02:00
[![Github All Releases](https://img.shields.io/github/downloads/xmrig/xmrig/total.svg)](https://github.com/xmrig/xmrig/releases)
2018-02-02 00:58:11 +02:00
[![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-pre/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/releases)
2018-02-02 00:14:39 +02: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)
2020-06-06 00:24:58 +07:00
XMRig High performance, open source, cross platform RandomX, KawPow, CryptoNight, AstroBWT and Argon2 CPU/GPU miner, with official support for Windows.
2019-11-02 04:03:03 +07:00
## Mining backends
- **CPU** (x64/x86/ARM)
- **OpenCL** for AMD GPUs.
- **CUDA** for NVIDIA GPUs via external [CUDA plugin](https://github.com/xmrig/xmrig-cuda).
2017-08-20 09:48:31 +03:00
2019-12-11 13:15:31 +07:00
<img src="doc/screenshot_v5_2_0.png" width="833" >
2017-04-15 09:56:09 +03:00
2017-04-15 09:02:08 +03:00
## Download
* Binary releases: https://github.com/xmrig/xmrig/releases
* Git tree: https://github.com/xmrig/xmrig.git
2017-08-18 06:47:51 +03:00
* Clone with `git clone https://github.com/xmrig/xmrig.git` :hammer: [Build instructions](https://github.com/xmrig/xmrig/wiki/Build).
2017-04-15 09:02:08 +03:00
## Usage
The preferred way to configure the miner is the [JSON config file](src/config.json) as it is more flexible and human friendly. The command line interface 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 calls.
2017-07-02 22:21:29 +03:00
2019-10-20 11:48:23 +07:00
* **[xmrig.com/wizard](https://xmrig.com/wizard)** helps you create initial configuration for the miner.
2019-11-02 04:03:03 +07:00
* **[workers.xmrig.info](http://workers.xmrig.info)** helps manage your miners via HTTP API.
2020-07-22 09:14:25 +07:00
* **[Command line options](https://xmrig.com/docs/miner/command-line-options)**
2017-04-15 09:02:08 +03:00
2017-04-15 09:46:16 +03:00
## Donations
2020-08-20 13:43:20 +07:00
* Default donation 1% (1 minute in 100 minutes) can be reduced to 1% via option `donate-level` or disabled in source code.
2017-04-15 09:46:16 +03:00
* XMR: `48edfHu7V9Z84YzzMa6fUueoELZ9ZRXq9VetWzYGzKt52XU5xvqgzYnDK9URnRoJMk1j8nLwEVsaSWJ4fhdUyZijBGUicoD`
2017-04-15 09:56:09 +03:00
* BTC: `1P7ujsXeX7GxQwHNnJsRMgAdNkFZmNVqJT`
2017-04-21 12:34:59 +03:00
## Contacts
* support@xmrig.com
* [reddit](https://www.reddit.com/user/XMRig/)
2018-10-01 13:36:03 +03:00
* [twitter](https://twitter.com/xmrig_dev)