Simplify repo README

[criadoperez]

Description

Simplified the README.md file.

• Updated links
• "blockstack" rebranding
• Moved some documentation to the official Stacks docs site
• Moved some contribution instructions to the contributions file.
• Added references to tutorials
• ~~Fixes failing CircleCI icon~~ --> Removes failing CircleCI icon

Closes #3196

[codecov[bot]]

Codecov Report

Merging #3247 (cc1d813) into master (db3c7a2) will decrease coverage by 0.01%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3247      +/-   ##
==========================================
- Coverage   82.78%   82.77%   -0.02%     
==========================================
  Files         260      260              
  Lines      203319   203319              
==========================================
- Hits       168325   168302      -23     
- Misses      34994    35017      +23     

Impacted Files	Coverage Δ
clarity/src/vm/ast/traits_resolver/mod.rs	94.44% <0.00%> (-3.97%)	:arrow_down:
clarity/src/vm/database/sqlite.rs	78.47% <0.00%> (-1.39%)	:arrow_down:
src/net/poll.rs	61.42% <0.00%> (-1.02%)	:arrow_down:
src/net/inv.rs	70.57% <0.00%> (-0.77%)	:arrow_down:
stacks-common/src/util/pipe.rs	88.40% <0.00%> (-0.54%)	:arrow_down:
clarity/src/vm/database/key_value_wrapper.rs	96.51% <0.00%> (-0.32%)	:arrow_down:
src/util_lib/bloom.rs	92.73% <0.00%> (-0.28%)	:arrow_down:
clarity/src/vm/functions/mod.rs	98.10% <0.00%> (-0.24%)	:arrow_down:
src/chainstate/stacks/index/storage.rs	78.91% <0.00%> (-0.23%)	:arrow_down:
src/chainstate/stacks/index/marf.rs	83.84% <0.00%> (-0.20%)	:arrow_down:
... and 18 more

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

[criadoperez]

Docs PR 1506 has merged

[wileyj]

CODE_OF_CONDUCT.md still mentions "blockstack" email address

[wileyj]

In the readme and other markdown, links can be removed in favor of "badges" i'd argue. something along the lines here: https://gist.github.com/tterb/982ae14a9307b80117dbf49f624ce0e8

where the license and version at least are listed. links to things like discord/youtube etc can also be added as badges vs text links.

[criadoperez]

In the readme and other markdown, links can be removed in favor of "badges" i'd argue. something along the lines here: https://gist.github.com/tterb/982ae14a9307b80117dbf49f624ce0e8

where the license and version at least are listed. links to things like discord/youtube etc can also be added as badges vs text links.

The scope of this PR is only for the README.md file. Other markdown files may require more changes than adding badges that will lead to further discussions, so I would rather make them on other PRs later. I added the badges for the license, however in my opinion, if we use a double license we need to clarify more. Original text stated that

This code is released under [the GPL v3 license](https://www.gnu.org/licenses/quick-guide-gplv3.en.html), and the docs are released under [the Creative Commons license](https://creativecommons.org/).

We don't specify what type of Creative Commons license and what exactly are the docs. If we only use GPLv3 license we can leave it with the latest change I made. But, if we want to keep using both licenses we need to first state what type of Creative Commons license we are using and specify what the docs are (for example, all files in the docs folder are CC Attribution 4.0 International.

Regarding the badges of the community section, yes I can replace them.

[wileyj]

Got it. I would argue that this is the correct PR to make all the changes. There's no rush on this, and there's no impact to taking longer to merge this -> it would actually save everyone's time to do a single PR vs many small PR's.

On Tue, Aug 16, 2022 at 4:30 AM Alejandro Criado-Pérez < @.***> wrote:

In the readme and other markdown, links can be removed in favor of "badges" i'd argue. something along the lines here: https://gist.github.com/tterb/982ae14a9307b80117dbf49f624ce0e8

where the license and version at least are listed. links to things like discord/youtube etc can also be added as badges vs text links.

The scope of this PR is only for the README.md file. Other markdown files may require more changes than adding badges that will lead to further discussions, so I would rather make them on other PRs later. I added the badges for the license, however in my opinion, if we use a double license we need to clarify more. Original text stated that

This code is released under the GPL v3 license, and the docs are released under the Creative Commons license.

We don't specify what type of Creative Commons license and what exactly are the docs. If we only use GPLv3 license we can leave it with the latest change I made. But, if we want to keep using both licenses we need to first state what type of Creative Commons license we are using and specify what the docs are (for example, all files in the docs folder are CC Attribution 4.0 International http://creativecommons.org/licenses/by/4.0/.

Regarding the badges of the community section, yes I can replace them.

— Reply to this email directly, view it on GitHub https://github.com/stacks-network/stacks-blockchain/pull/3247#issuecomment-1216509612, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAVXIHBJ5S6KRLMDDJMGBL3VZN3VFANCNFSM56FOKZ4A . You are receiving this because you commented.Message ID: @.***>

[criadoperez]

I would argue that this is the correct PR to make all the changes

ok. If that's the case then I'll also review the other markdown files.

[criadoperez]

CODE_OF_CONDUCT.md still mentions "blockstack" email address

Corrected. Thanks for pointing this out.