Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #71

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,28 @@
# xmrig-cuda
This repository is NVIDIA CUDA plugin for XMRig miner v4.5+ and it adds support for NVIDIA GPUs in XMRig miner.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-----BEGIN PGP SIGNATURE-----

iQEzBAABCgAdFiEEmsTOqOZuNaXHzdwbRGpTY4vpRAkFAmEQ+nAACgkQRGpTY4vp
RAntbgf/XG8st5avkpgP0MUhQJACHqKH9+mWWAXDer9/w8cP0kI3JkD3O9YW5RHJ
n5t/K6QxWVoPUTW9zXpfftkxBeMJ+ApGOW+MV76IcTPg4Nd5vGTOqyZGKpE23yja
cinFEHwr9cIAd45VWyasXSxTyva9ZNmJFBrL7/8zGYLHMfM9EKbMmYFCo6bPwOgT
8SkRuXY3P9YGbrmHRMVgTnSanV/qn/ADe3A3G+QEVfQbd9KFKsNY1o4/Zsfzpa9/
49be5wfpDALHjA6VrOB2ztt+5tPfEqx7nuxkoV+XusGixTxE5LuejF1wWXU94tjd
ijXmm+WJhfp20VqQPy1kke1tjH+btw==
=Y87K
-----END PGP SIGNATURE-----
Q


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

This repository is NVIDIA CUDA plugin for [XMRig](../../../xmrig) miner v4.5+ and it adds support for NVIDIA GPUs in [XMRig](../../../xmrig) miner.

Main reasons why this plugin is separated project is:
1. CUDA support is optional, not all users need it, but it is very heavy.
2. CUDA has very strict compiler version requirements, it may conflicts with CPU mining code, for example now possible build the miner with gcc on Windows (CUDA works only with MSVC).


## Table of Contents

- [Windows usage](#windows-usage)
- [Advanced](#advanced)
- [Linux usage](#linux-usage)

## Windows usage

* [Download](https://github.com/xmrig/xmrig-cuda/releases) plugin, you must choose CUDA version, usually it recent version (CUDA 10.1), but builds with older CUDA version also provided, alternative you can build the plugin from source.
* [Download](../../releases) plugin, you must choose CUDA version, usually it recent version (CUDA 10.1), but builds with older CUDA version also provided, alternative you can build the plugin from source.
* Place **`xmrig-cuda.dll`** and other dll files near to **`xmrig.exe`**.
* Edit **`config.json`** to enable CUDA support.
```
Expand Down