Skip to content

Commit cb4dfea

Browse files
committed
[readme] Update the documentation
1 parent 1286d68 commit cb4dfea

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ This role will install and configure the mining tool `xmr-stak` on Linux operati
66

77
* [Features](#features)
88
* [Quickstart](#quickstart)
9-
- [Requirements](#requirements)
9+
- [Pre-requirements](#pre-requirements)
10+
- [Deployment](#deployment)
1011
- [CPU backend](#cpu)
1112
- [NVIDIA backend](#nvidia) *(experimental)*
1213
- [AMD/ATI backend](#amd/ati) *(experimental)*
@@ -27,7 +28,7 @@ Supported algorithms:
2728

2829
## Quickstart
2930

30-
### Requirements
31+
### Pre-requirements
3132

3233
Ubuntu/Debian
3334
```
@@ -42,6 +43,8 @@ CentOS 7
4243
$ sudo yum install python-pip -y
4344
```
4445

46+
### Deployment
47+
4548
```
4649
$ sudo pip install -U pip ansible
4750
$ mkdir -p ~/ansible/{inventories/xmr-stak,playbooks/xmr-stak,roles}

docs/ADVANCED.md

+4
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,8 @@ The role doesn't have any dependency, you could just run `ansible-galaxy install
129129

130130
## Make it run
131131

132+
### Pre-requirements
133+
132134
Few things to prepare before starting.
133135
Ubuntu/Debian
134136
```
@@ -143,6 +145,8 @@ CentOS 7
143145
$ sudo yum install python-pip -y
144146
```
145147

148+
### Deployment
149+
146150
```
147151
$ sudo pip install -U pip ansible
148152
$ mkdir -p ~/ansible/{inventories/xmr-stak,playbooks/xmr-stak,roles}

0 commit comments

Comments
 (0)