@@ -1,2 +1,55 @@
11# xmrig-bash-scripts
2−Simple collection of bash shell scripts I use to manage xmrig cpu
2+A simple collection of bash shell scripts to manage installation, update and configuration of [xmrig cpu](https://github.com/xmrig/xmrig) across multiple hosts.
3+
4+
5+## Download
6+* https://github.com/seanwhe/xmrig-bash-scripts
7+* Git clone with `git clone https://github.com/seanwhe/xmrig-bash-scripts`
8+
9+### Prerequisites
10+
11+* Ubuntu Linux (or other Debian-based distribution)
12+* User account with sudo privileges
13+
14+### Installion
15+
16+1. Change in to the cloned directory
17+ `cd xmrig-bash-scripts`
18+
19+2. Edit the settings file to your preference.
20+ `vim settings.sh`
21+
22+3. Run the install script
23+ `./install.sh`
24+
25+The install script do the following:
26+1. Load the settings ensuring that your user has passwordless sudo and that vm.nr_hugepages is set.
27+2. Stop any existing screen session runing xmrig.
28+3. Run apt update, upgrade, autoremove, autoclean on system.
29+4. Install required build dependencies.
30+5. Git clone xmrig source to ~/xmrig-bash-scripts/xmrig-cpui/ and change to specified branch
31+6. Build and install xmrig to /usr/bin
32+7. Start a screen named xmrig-cpu running xmrig
33+
34+## Viewing mining process
35+`screen -r xmrig-cpu`
36+
37+Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
38+
39+## Versioning
40+
41+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/seanwhe/xmrig-bash-scripts/tags).
42+
43+## Authors
44+
45+* **Sean Wheller** - *Initial work* - [seanwhe](https://github.com/seanwhe)
46+
47+See also the list of [contributors](https://github.com/seanwhe/xmrig-bash-scripts/CONTRIBUTORS
48+
49+## License
50+
51+This project is licensed under the GNU General Public License v3.0 - see the [LICENSE.md](LICENSE.md) file for details
52+
53+## Acknowledgments
54+
55+* Thanks to [fireice-uk](https://github.com/fireice-uk) for developing and maintaining xmrig