diff --git a/README.md b/README.md index a6c76899bb..a7ced04868 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ What is Gridcoin? ================= -Gridcoin is a POS-based cryptocurrency that rewards users for participating on the BOINC network. -Gridcoin uses peer-to-peer technology to operate with no central authority - managing transactions, issuing money and contributing to scientific research are carried out collectively by the network. +Gridcoin is a POS-based cryptocurrency that rewards users for participating on the [BOINC](https://boinc.berkeley.edu/) network. +Gridcoin uses peer-to-peer technology to operate with no central authority - managing transactions, issuing money and contributing to scientific research are carried out collectively by the network. -For Gridcoin binaries, as well as more information, see http://gridcoin.us/. +For Gridcoin binaries, as well as more information, see https://gridcoin.us/. Building Gridcoin -================ +================= These dependencies are required: Library | Purpose | Description - ------------|------------------|---------------------- + ------------|------------------|---------------------------------------------------------------- libssl | Crypto | Random Number Generation, Elliptic Curve Cryptography libboost | Utility | Library for threading, data structures, etc libevent | Networking | OS independent asynchronous networking @@ -22,29 +22,22 @@ These dependencies are required: libqrencode | QR codes in GUI | Optional for generating QR codes (only needed when GUI enabled) To build, run -``` ./autogen.sh && ./configure && make```. +```./autogen.sh && ./configure && make```. For more detailed and platform-specific instructions, see [the doc folder.](doc/) - - Development process -=========================== - -The master branch is regularly built and tested, but is not guaranteed -to be completely stable. [Tags](https://github.com/gridcoin/Gridcoin-Research/tags) -are created regularly to indicate new official, stable release versions -of Gridcoin. +=================== Developers work in their own trees, then submit pull requests to the development branch when they think their feature or bug fix is ready. The patch will be accepted if there is broad consensus that it is a -good thing. Developers should expect to rework and resubmit patches +good thing. Developers should expect to rework and resubmit patches if they don't match the project's coding conventions (see [coding.txt](doc/coding.txt)) or are controversial. The master branch is regularly built and tested, but is not guaranteed -to be completely stable. [Tags](https://github.com/gridcoin/Gridcoin-Research/tags) are regularly created to indicate new +to be completely stable. [Tags](https://github.com/gridcoin-community/Gridcoin-Research/tags) are regularly created to indicate new stable release versions of Gridcoin. Feature branches are created when there are major new features being @@ -76,19 +69,18 @@ being merged to *master* for release. This allows for production updates without master if the staging branch is busy. Community -============ +========= -For general questions, see the forum at https://cryptocurrencytalk.com/forum/464-gridcoin-grc/, or freenode irc on #gridcoin. We also have a Slack channel at teamgridcoin.slack.com. +For general questions, see the forum at https://cryptocurrencytalk.com/forum/464-gridcoin-grc/, or Freenode IRC in #gridcoin-help. We also have a Slack channel at [teamgridcoin.slack.com](https://join.slack.com/t/teamgridcoin/shared_invite/enQtMjk2NTI4MzAwMzg0LTUzMmY0YjdiNzYxYzQ0MDc3MGE1NjQ3Nzg2NWMzZTUzMjAwZjdhMWI1YWUzMDE4YzQyZjVjMjMzOTc1M2RmMmM/). License --------- +------- Gridcoin is released under the terms of the MIT license. See [COPYING](COPYING) or https://opensource.org/licenses/MIT for more information. - Build Status -============= +============ | Development | Staging | Master | |----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|