nim-ethash/README.md

# ethash

[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
![Github action](https://github.com/status-im/nim-ethash/workflows/CI/badge.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).

# 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.

## License

Licensed and distributed under either of

* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT

or

* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)

at your option. This file may not be copied, modified, or distributed except according to those terms.
ci: update readme: fix license, badges 2018-09-05 04:00:14 +00:00			`# ethash`
initial commit 2018-02-15 10:23:42 +00:00
ci: update readme: fix license, badges 2018-09-05 04:00:14 +00:00			`[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)`
			`[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)`
			`![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)`
add github action 2022-04-07 15:06:37 +00:00			`![Github action](https://github.com/status-im/nim-ethash/workflows/CI/badge.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
ci: update readme: fix license, badges 2018-09-05 04:00:14 +00:00			`Implementation is based on the [spec revision 23 (2017-08-03)](https://github.com/ethereum/wiki/wiki/Ethash).`
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.`
ci: update readme: fix license, badges 2018-09-05 04:00:14 +00:00
			`## License`

readme: update license 2018-09-05 18:47:14 +00:00			`Licensed and distributed under either of`

			`* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT`

Update README.md 2019-01-02 14:04:24 +00:00			`or`

			`* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)`
ci: update readme: fix license, badges 2018-09-05 04:00:14 +00:00
Update README.md 2019-01-02 14:04:24 +00:00			`at your option. This file may not be copied, modified, or distributed except according to those terms.`