@@ -19,11 +19,11 @@ At the start the expectation is that you have:
20Some knowledge of:
20Some knowledge of:
21* Linux Command Line Interface
21* Linux Command Line Interface
22−* Unix shell `bash`
22+* Linux shell `bash`
24There is more to install but the install script will install the rest.
24There is more to install but the install script will install the rest.
26−### Installion
26+### Installation
281. Change to your user home directory.
281. Change to your user home directory.
@@ -43,34 +43,40 @@ There is more to install but the install script will install the rest.
436. Run the install script
436. Run the install script
44 `./install.sh`
44 `./install.sh`
46−7. Attach to the screen session created during the installation.
46+7. After install is complete. Attach to the screen session created during the installation.
47 `screen -r`
47 `screen -r`
49### Operation
49### Operation
51−With the exception of the 'xmrig' binary, which is installed to `/usr/bin/xmrig`, all files remain in the cloned project directory `~/xmrig-bash-scripts`. Any files generated while running the scripts are created in this directory.
51+Defaults - The settings.sh contains a number of variables. With the exception of the 'xmrig' binary, which is installed to `/usr/bin/xmrig`, all files remain in the cloned project directory `~/xmrig-bash-scripts`. Any files generated while running the scripts are also created in this directory.
53−During install the folder source for [xmrig cpu](https://github.com/xmrig/xmrig) is cloned to `xmrig-cpu/`in the path. The `config.json` is also created in this path.
53+During install the folder source for [xmrig cpu](https://github.com/xmrig/xmrig) is cloned to `~/xmrig-bash-scripts/xmrig-cpu/`. The `config.json` is also created in this path.
55−This should work out the box, if you edit only the top section of `settings.sh`.
55+This should work out the box, if you edit only the top section of `settings.sh` and followed the steps here.
57Once you have a running xmrig then you can start playing around and tweaking to suite requirements.
57Once you have a running xmrig then you can start playing around and tweaking to suite requirements.
59+What follows is a brief of the shell scripts you will find. The names are mostly self explanatory.
60+Comments and notes are used liberally in the scripts to help give you hints as to how it works.
59−What follows is a brief of the shell scripts you will find. The names are mostly self explanatory. Comments and notes are used liberally in the scripts to help give you hints as to how it works. The scripts are designed to be modular to promote resuse, execute exclusion and standalone execution.
61+The scripts are designed to be modular to promote resuse, execute exclusion and standalone execution.
61* build.sh - clones xmrig to ``~/xmrig-bash-scripts`/xmrig-cpu`, configures, builds and copies xmrig to `/usr/bin/`
63* build.sh - clones xmrig to ``~/xmrig-bash-scripts`/xmrig-cpu`, configures, builds and copies xmrig to `/usr/bin/`
62* config.sh - contains variables that aid in defining the values for the attributes found in config.json.
64* config.sh - contains variables that aid in defining the values for the attributes found in config.json.
63* crontab.sh - installs a cron to start and a cron to stop at specific times (Can be commented out of install if desired).
65* crontab.sh - installs a cron to start and a cron to stop at specific times (Can be commented out of install if desired).
66+* crontab-off - removed the users crontab created during install.
67+* crontab-on.sh - redefines the users crontab as created during install.
64* depends.sh - installs dependancies required by xmrig and these scripts.
68* depends.sh - installs dependancies required by xmrig and these scripts.
65* functions.sh - a collection of functions used in various of the scripts.
69* functions.sh - a collection of functions used in various of the scripts.
66* install.sh - the main entry point when first installing.
70* install.sh - the main entry point when first installing.
67−* maintenance.sh - performs apt update and upgrade.
71+* maintenance.sh - performs apt update, upgrade, autoremove and autoclean operations.
68* settings.sh - contains variables used by these scripts.
72* settings.sh - contains variables used by these scripts.
69* start.sh - starts xmrig in a screen session.
73* start.sh - starts xmrig in a screen session.
70* stop.sh - stops xmrig screen session.
74* stop.sh - stops xmrig screen session.
72### Viewing the log
76### Viewing the log
77+Default of the start script is to create a screen session named 'xmrig-cpu'.
78+This can be changed in the settings script if required.
73−Default of the start script is to create a screen session named 'xmrig-cpu'. This can be changed in the settings script if required. To view the log after installation is finished or after running the start script, used the following command:
79+To view the log after installation is finished or after running the start script, used the following command:
74`screen -r xmrig-cpu`
80`screen -r xmrig-cpu`
76### Updating
82### Updating
@@ -79,11 +85,14 @@ A simple `git update` in `~/xmrig-bash-scripts` will update these scripts.
79The install script can be run at any time to update the xmrig source found `~/xmrig-bash-scripts/xmrig-cpu`.
85The install script can be run at any time to update the xmrig source found `~/xmrig-bash-scripts/xmrig-cpu`.
80The branch checkout is taken from the `_XMRIG_BRANCH` variable in `settings.sh`.
86The branch checkout is taken from the `_XMRIG_BRANCH` variable in `settings.sh`.
88+A script named update.sh is provided to perform both these steps in a single command.
82## Reporting issues
90## Reporting issues
84[xmrig cpu](https://github.com/xmrig/xmrig) and [xmrig bash scripts](https://github.com/seanwhe/xmrig-bash-scripts.git) are different projects run by different people.
92[xmrig cpu](https://github.com/xmrig/xmrig) and [xmrig bash scripts](https://github.com/seanwhe/xmrig-bash-scripts.git) are different projects run by different people.
86−While the developers of both projects may be seen interacting with one another on either project, we ask that you report issues to the respective projects. In other words, post issues for:
94+While the developers of both projects may be seen interacting with one another on either project, we ask that you report issues to the respective projects.
95+In other words, post issues for:
87* xmrig, the Monero (XMR) CPU miner, over at [xmrig issues tracker](https://github.com/xmrig/xmrig/issues)
96* xmrig, the Monero (XMR) CPU miner, over at [xmrig issues tracker](https://github.com/xmrig/xmrig/issues)
88* xmrig-bash-scripts, these conveniece scripts, over at [xmrig-bash-scripts](https://github.com/seanwhe/xmrig-bash-scripts/issues)
97* xmrig-bash-scripts, these conveniece scripts, over at [xmrig-bash-scripts](https://github.com/seanwhe/xmrig-bash-scripts/issues)