diff --git a/README.md b/README.md index 066aa0ab..8f94dcb2 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![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](https://snapcraft.io/xmrig/badge.svg)](https://snapcraft.io/xmrig) 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. @@ -18,6 +19,11 @@ XMRig is a high performance, open source, cross platform RandomX, KawPow, Crypto * **[Binary releases](https://github.com/xmrig/xmrig/releases)** * **[Build from source](https://xmrig.com/docs/miner/build)** +## Install the snap +* **[![xmrig](https://snapcraft.io/xmrig/badge.svg)](https://snapcraft.io/xmrig)** +* For stable snap release: `sudo snap install xmrig` +* To stay on the latest releases: `sudo snap install --edge xmrig` + ## 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. diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml new file mode 100644 index 00000000..a4e4568b --- /dev/null +++ b/snap/snapcraft.yaml @@ -0,0 +1,69 @@ +name: xmrig +adopt-info: xmrig +summary: XMRig is a high performance, open source, cross platform CPU/GPU miner +description: | + XMRig is a high performance, open source, cross platform RandomX, KawPow, + CryptoNight and AstroBWT unified CPU/GPU miner and RandomX benchmark. Official + binaries are available for Windows, Linux, macOS and FreeBSD. + +license: GPL-3.0 + +base: core20 +grade: stable +confinement: strict +compression: lzo + +architectures: + - build-on: amd64 + run-on: [amd64, armhf, arm64, ppc64el] + +assumes: + - command-chain + +apps: + xmrig: + command: bin/xmrig + command-chain: + - bin/homeishome-launch + plugs: + - home + - network + - network-bind + - opengl + +parts: + xmrig: + source: https://github.com/xmrig/xmrig + source-type: git + plugin: nil + + override-build: | + git clone https://github.com/xmrig/xmrig.git + mkdir -p build && cd build + cmake .. + make -j$(nproc) + mkdir -p $SNAPCRAFT_PART_INSTALL/bin/ + cp xmrig $SNAPCRAFT_PART_INSTALL/bin/ + + override-pull: | + snapcraftctl pull + snapcraftctl set-version "$(git describe --tags | sed 's/^v//' | cut -d "-" -f1)" + + build-packages: + - build-essential + - git + - cmake + - libuv1-dev + - libssl-dev + - libhwloc-dev + + stage-packages: + - libuv1-dev + - libssl-dev + - libhwloc-dev + + homeishome-launch: + plugin: nil + stage-snaps: + - homeishome-launch +