swarm: README.md #17233
Merged
swarm: README.md #17233
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zelig
approved these changes
Jul 25, 2018
|
@zelig please use the squash commits button when merging PRs to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'd like to merge this README.md under the
swarm/folder with the purpose of it being the main entrypoint for Swarm, alongside our website (https://swarm.ethereum.org). I think it would be nice to have a README.md close to the code, where we can add useful commands, links to documentation, and basically a general "Getting Started" guide. I think the main documentation - https://swarm-guide.readthedocs.io - should be a comprehensive guide, whereas this is just a quick entrypoint for new people.I think this should also make it clear that
ethereum/go-ethereumis the source of truth for the codebase, and thatethersphereis a fork for the core team to communicate and organise better.