Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
any1 committed Nov 11, 2018
1 parent 6b05a3d commit 37141bd
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
.project
.settings
.classpath
Makefile
xel_miner
CMakeCache.txt
compat/
CMakeFiles

ElasticPL/cmake_install\.cmake

cmake_install\.cmake
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,33 @@ ElasticPL v0.9.1

**The miner build has been tested using GCC on Ubuntu 16.04 as well as MinGW32 (using GCC) on Windows 7/10.**

### install pre-requisities

##### Linux

```
apt-get update
apt-get install -y cmake libcurl4-openssl-dev libudev-dev screen libtool pkg-config libjansson-dev libssl-dev
```

##### macOS

you must first install homebrew (if not already installed):

```
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```

Then proceed with the installation :

```
brew install gmp make cmake openssl
ln -s /usr/local/opt/openssl/include/openssl /usr/local/include/openssl
```

### build

```
git clone --depth 1 https://github.com/xel-software/xel-miner
cd xel-miner
```
Expand All @@ -45,11 +69,13 @@ make install
```


### To run the Miner using CPU:
### run

##### using CPU:

`./xel_miner -t <num_threads> -P <secret_phrase> -D`

### To run the Miner using GPU:
##### using GPU:

`./xel_miner -t <num_threads> -P <secret_phrase> -D --opencl`

Expand Down

0 comments on commit 37141bd

Please sign in to comment.