Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FSOL-XDAG committed Jul 3, 2023
1 parent b5c66f0 commit 7ffb545
Showing 1 changed file with 39 additions and 26 deletions.
65 changes: 39 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,51 @@
# XMRig
# XMRig-4-XDAG

[![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)
[![Github All Releases](https://img.shields.io/github/downloads/FSOL-XDAG/xmrig-4-xdag/total.svg)]()
[![GitHub release](https://img.shields.io/github/release/FSOL-XDAG/xmrig-4-xdag/all.svg)](https://github.com/FSOL-XDAG/xmrig-4-xdag/releases)
[![GitHub Release Date](https://img.shields.io/github/release-date/FSOL-XDAG/xmrig-4-xdag.svg)](https://github.com/FSOL-XDAG/xmrig-4-xdag/releases)
[![GitHub license](https://img.shields.io/github/license/FSOL-XDAG/xmrig-4-xdag.svg)](https://github.com/FSOL-XDAG/xmrig-4-xdag/blob/master/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/FSOL-XDAG/xmrig-4-xdag.svg)](https://github.com/FSOL-XDAG/xmrig-4-xdag/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/FSOL-XDAG/xmrig-4-xdag.svg)](https://github.com/FSOL-XDAG/xmrig-4-xdag/network)

XMRig is a high performance, open source, cross platform RandomX, KawPow, CryptoNight 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.
![x4x_spash](https://user-images.githubusercontent.com/128682335/227436274-10a8321c-7b75-4f70-a304-e7ab34f74e16.png)

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

## Download
* **[Binary releases](https://github.com/xmrig/xmrig/releases)**
* **[Build from source](https://xmrig.com/docs/miner/build)**
**x4x** is a strict XMRIG's fork incorporating randomX algorithm variant for mining XDAG. It's based on the [Swordlet project](https://github.com/swordlet/xmrig/tree/xdag) using [XMRig 6.18.0](https://github.com/xmrig/xmrig/releases/tag/v6.18.0). It's specially designed to improve XDAG mining :

## 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.
* **algorithms other than RandomX have been removed** at compilation (_CryptoNight, Argon2, KawPow and GhostRider_),
* **_CUDA_ and _OpenCL_ support have been removed** at compilation too (_GPUs are useless to mine XDAG_).
* **the fees have been set to zero** for improving mining and to avoid disconnections to XDAG mining pools,

* **[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.
## Available on theses OS/platforms :
* Windows 10 x64 and upper.
* Linux Ubuntu x64 18.04 / 20.04 / 22.04 / 23.04
* Debian 11 ARM64 (Rpi 4 & android smartphone)
* Hive OS (Ubuntu 18.04)
* FreeBSD 13.2
* MacOS x64 darwin (10.5.x and upper)
* CentOS 8

## How to compile
Check Github [wiki pages](https://github.com/FSOL-XDAG/xmrig-4-xdag/wiki#how-to-build).

## Donations
* Default donation 1% (1 minute in 100 minutes) can be increased via option `donate-level` or disabled in source code.
* XMR: `48edfHu7V9Z84YzzMa6fUueoELZ9ZRXq9VetWzYGzKt52XU5xvqgzYnDK9URnRoJMk1j8nLwEVsaSWJ4fhdUyZijBGUicoD`
* If you appreciate this work, feel free to send me some XDAG as tips (remark : `x4x tips`).
* XDAG: `53r2nH7y81CePxqe73mpoZdEjs66j178K`

## Developers
## XMRig 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)
## x4x Developer
* **[FSOL-XDAG](https://github.com/FSOL-XDAG)**

## Usefull link
* [Medium](https://medium.com/@fsol)
* [XDAG.eu](https://www.xdag.eu)
* [Discord](https://discord.gg/fHE4sJ7NKt)
* [Twitter](https://twitter.com/Chrix_Switch)
* [How to](https://1to.fr)

## Contact
* fsol@xdag.io

0 comments on commit 7ffb545

Please sign in to comment.