grin/README.md

[![Build Status](https://travis-ci.org/mimblewimble/grin.svg?branch=master)](https://travis-ci.org/mimblewimble/grin) [![Gitter chat](https://badges.gitter.im/grin_community/Lobby.png)](https://gitter.im/grin_community/Lobby) [![Codecov coverage status](https://codecov.io/gh/mimblewimble/grin/branch/master/graph/badge.svg)](https://codecov.io/gh/mimblewimble/grin)

# Grin

Grin is an in-progress implementation of the MimbleWimble protocol. Many characteristics are still undefined but the following constitutes a first set of choices:

  * Clean and minimal implementation, aiming to stay as such.
  * Follows the MimbleWimble protocol, which provides great anonymity and scaling characteristics.
  * Cuckoo Cycle proof of work.
  * Relatively fast block time (a minute).
  * Fixed block reward over time with a decreasing dilution.
  * Transaction fees are based on the number of Outputs created/destroyed and total transaction size.
  * Smooth curve for difficulty adjustments.

To learn more, read our [introduction to MimbleWimble and Grin](doc/intro.md).

## Status

Grin is still an infant, much is left to be done and [contributions](CONTRIBUTING.md) are welcome (see below). Check our [mailing list archives](https://lists.launchpad.net/mimblewimble/) for the latest status.

## Contributing

To get involved, read our [contributing docs](CONTRIBUTING.md).

Find us:

* Chat: [Gitter](https://gitter.im/grin_community/Lobby).
* Mailing list: join the [~MimbleWimble team](https://launchpad.net/~mimblewimble) and subscribe on Launchpad.
* Twitter for the Grin council: [@grincouncil](https://twitter.com/grincouncil)

## Getting Started

To learn more about the technology, read our [introduction](doc/intro.md).

To build and try out Grin, see the [build docs](doc/build.md).

## Philosophy

Grin likes itself small and easy on the eyes. It wants to be inclusive and welcoming for all walks of life, without judgement. Grin is terribly ambitious, but not at the detriment of others, rather to further us all. It may have strong opinions to stay in line with its objectives, which doesn't mean disrespect of others' ideas.

We believe in pull requests, data and scientific research. We do not believe in unfounded beliefs.

## Credits

Tom Elvis Jedusor for the first formulation of MimbleWimble.

Andrew Poelstra for his related work and improvements.

John Tromp for the Cuckoo Cycle proof of work.

J.K. Rowling for making it despite extraordinary adversity.

## License

Apache License v2.0.
Add kcov support (#545) * Adding kcov code coverage to chain and core modules * Adjust travis.yml to wget kcov from mimblewimble org * Add codecov badge to README.md * Fix repo name in badge to grin, from kcov 2017-12-27 05:09:10 +03:00			`[![Build Status](https://travis-ci.org/mimblewimble/grin.svg?branch=master)](https://travis-ci.org/mimblewimble/grin) [![Gitter chat](https://badges.gitter.im/grin_community/Lobby.png)](https://gitter.im/grin_community/Lobby) [![Codecov coverage status](https://codecov.io/gh/mimblewimble/grin/branch/master/graph/badge.svg)](https://codecov.io/gh/mimblewimble/grin)`
Badges. 2016-12-16 03:46:16 +03:00
Initial import. 2016-10-21 03:06:12 +03:00			`# Grin`

			`Grin is an in-progress implementation of the MimbleWimble protocol. Many characteristics are still undefined but the following constitutes a first set of choices:`

			`* Clean and minimal implementation, aiming to stay as such.`
			`* Follows the MimbleWimble protocol, which provides great anonymity and scaling characteristics.`
Minor updates 2018-03-26 01:35:06 +03:00			`* Cuckoo Cycle proof of work.`
			`* Relatively fast block time (a minute).`
			`* Fixed block reward over time with a decreasing dilution.`
Remove Sumtree References and disambiguate some naming (#747) * start of renamathon * api renaming * Rename UTXO-Output to lessen ambiguity * compile warning * compile error * readme fix * remove file commit in error 2018-03-05 22:33:44 +03:00			`* Transaction fees are based on the number of Outputs created/destroyed and total transaction size.`
Initial import. 2016-10-21 03:06:12 +03:00			`* Smooth curve for difficulty adjustments.`

Link introduction doc in README. 2017-03-21 21:18:09 +03:00			`To learn more, read our [introduction to MimbleWimble and Grin](doc/intro.md).`

Initial import. 2016-10-21 03:06:12 +03:00			`## Status`

git pre-commit hook to run rustfmt on modified files (#110) * git pre-commit hook to run rustfmt on modified files * add docs for rustfmt * add CONTRIBUTING file 2017-09-01 03:54:15 +03:00			`Grin is still an infant, much is left to be done and [contributions](CONTRIBUTING.md) are welcome (see below). Check our [mailing list archives](https://lists.launchpad.net/mimblewimble/) for the latest status.`
Initial import. 2016-10-21 03:06:12 +03:00
			`## Contributing`

git pre-commit hook to run rustfmt on modified files (#110) * git pre-commit hook to run rustfmt on modified files * add docs for rustfmt * add CONTRIBUTING file 2017-09-01 03:54:15 +03:00			`To get involved, read our [contributing docs](CONTRIBUTING.md).`
Initial import. 2016-10-21 03:06:12 +03:00
Small doc adjustment to add IRC. 2016-11-09 22:17:58 +03:00			`Find us:`

Replace IRC with Gitter 2017-03-24 03:04:00 +03:00			`* Chat: [Gitter](https://gitter.im/grin_community/Lobby).`
Added reference to the mailing list. 2016-12-08 21:22:06 +03:00			`* Mailing list: join the [~MimbleWimble team](https://launchpad.net/~mimblewimble) and subscribe on Launchpad.`
Readme twitter link for the council 2018-10-09 21:39:34 +03:00			`* Twitter for the Grin council: [@grincouncil](https://twitter.com/grincouncil)`
Small doc adjustment to add IRC. 2016-11-09 22:17:58 +03:00
Add some basic build instructions to help people get started (#50) 2017-05-03 23:56:03 +03:00			`## Getting Started`

Minor clarifications and additional getting started link 2017-05-04 00:23:12 +03:00			`To learn more about the technology, read our [introduction](doc/intro.md).`
Add some basic build instructions to help people get started (#50) 2017-05-03 23:56:03 +03:00
Minor clarifications and additional getting started link 2017-05-04 00:23:12 +03:00			`To build and try out Grin, see the [build docs](doc/build.md).`
Initial import. 2016-10-21 03:06:12 +03:00
			`## Philosophy`

Many typo fixes (#1158) * Typo fix * Parameterise 2018-06-13 19:03:34 +03:00			`Grin likes itself small and easy on the eyes. It wants to be inclusive and welcoming for all walks of life, without judgement. Grin is terribly ambitious, but not at the detriment of others, rather to further us all. It may have strong opinions to stay in line with its objectives, which doesn't mean disrespect of others' ideas.`
Initial import. 2016-10-21 03:06:12 +03:00
			`We believe in pull requests, data and scientific research. We do not believe in unfounded beliefs.`

			`## Credits`

			`Tom Elvis Jedusor for the first formulation of MimbleWimble.`
Corrected spelling of Cuckoo Cycle here and there and updated easiness to 50% following @tromp feedback. 2016-10-22 01:02:20 +03:00
Initial import. 2016-10-21 03:06:12 +03:00			`Andrew Poelstra for his related work and improvements.`
Corrected spelling of Cuckoo Cycle here and there and updated easiness to 50% following @tromp feedback. 2016-10-22 01:02:20 +03:00
			`John Tromp for the Cuckoo Cycle proof of work.`

Initial import. 2016-10-21 03:06:12 +03:00			`J.K. Rowling for making it despite extraordinary adversity.`

			`## License`

			`Apache License v2.0.`