nim-ethash/README.md

**Nim Ethash**

[![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-ethash/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-ethash)[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)

# Introduction
A pure-Nim implementation of Ethash, the Ethereum proof of work

Implementation is based on the [spec revision 23 (2017-08-03)](https://github.com/ethereum/wiki/wiki/Ethash) and is under the Apache License v2.

# Mining
An unoptimized mining CPU backend is available through the compile-time flag ``-d:ethash_mining``.
It requires compilation through the C++ backend.

# Optimizations
For maximum speed, compile Ethash with `-d:release -d:march_native -d:openmp`.
This will compile Ethash in Nim release mode, with all supported CPU extensions (especially AVX2) and with OpenMP multiprocessing. On MacOS, OpenMP requires installing GCC-7 and can be done through Homebrew.

# Original implementation
Original Ethereum implementation is available [here](https://github.com/ethereum/ethash).

**Warning ⚠ - License notice**: the original implementation is under GPLv3 or LGPLv3 and must not be used in this project.
Update README.md 2018-05-28 05:26:38 +00:00			`Nim Ethash`
initial commit 2018-02-15 10:23:42 +00:00
Switch to nimcrypto (#6) fix #9 * Cosmetic change on the conversion proc + keep a copy of keccak_tiny implementation as benchmark * Update ethash to use nimcrypto * Use the same CI build system as Nimbus 2018-07-23 12:52:14 +00:00			`[![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-ethash/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-ethash)[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)`
initial commit 2018-02-15 10:23:42 +00:00
Update README.md 2018-05-28 05:26:38 +00:00			`# Introduction`
			`A pure-Nim implementation of Ethash, the Ethereum proof of work`
initial commit 2018-02-15 10:23:42 +00:00
Update README.md 2018-05-28 05:26:38 +00:00			`Implementation is based on the [spec revision 23 (2017-08-03)](https://github.com/ethereum/wiki/wiki/Ethash) and is under the Apache License v2.`
initial commit 2018-02-15 10:23:42 +00:00
Update README.md 2018-05-28 05:26:38 +00:00			`# Mining`
Prepare tests files for mining tests 2018-02-27 10:29:46 +00:00			An unoptimized mining CPU backend is available through the compile-time flag ``-d:ethash_mining``.
			`It requires compilation through the C++ backend.`

Update README.md 2018-05-28 05:26:38 +00:00			`# Optimizations`
:fire: Speed and memory optimizations (OpenMP !): - OpenMP multiprocessing for dataset generation - remove some temporaries - add march_native flag 2018-02-28 17:46:28 +00:00			For maximum speed, compile Ethash with `-d:release -d:march_native -d:openmp`.
Update README.md 2018-05-28 05:26:38 +00:00			`This will compile Ethash in Nim release mode, with all supported CPU extensions (especially AVX2) and with OpenMP multiprocessing. On MacOS, OpenMP requires installing GCC-7 and can be done through Homebrew.`
:fire: Speed and memory optimizations (OpenMP !): - OpenMP multiprocessing for dataset generation - remove some temporaries - add march_native flag 2018-02-28 17:46:28 +00:00
Update README.md 2018-05-28 05:26:38 +00:00			`# Original implementation`
initial commit 2018-02-15 10:23:42 +00:00			`Original Ethereum implementation is available [here](https://github.com/ethereum/ethash).`

:fire: Speed and memory optimizations (OpenMP !): - OpenMP multiprocessing for dataset generation - remove some temporaries - add march_native flag 2018-02-28 17:46:28 +00:00			`Warning ⚠ - License notice: the original implementation is under GPLv3 or LGPLv3 and must not be used in this project.`