Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup readme #8177

Closed
ghost opened this issue Feb 8, 2020 · 7 comments
Closed

Cleanup readme #8177

ghost opened this issue Feb 8, 2020 · 7 comments
Labels
locked issue stale [bot only] Added to stale content; results in auto-close after a week.
Milestone

Comments

@ghost
Copy link

ghost commented Feb 8, 2020

Furthermore nothing in this project constitutes a solicitation for investment.

This, and many other writings, do not belong into the Readme.

Focus on usual stuff, compact.

Before you jump into the code, review the online book Solana: Blockchain Rebuilt for Scale.

no! provide an archetuctaral overview diagram to llok at, and point to it from the readme.

@garious
Copy link
Contributor

garious commented Feb 8, 2020

Regulations around crypto are fuzzy at best. We'll continue to follow the advice of our legal team and navigate the space conservatively.

Regarding the architectural diagram, we can add that, but it won't get you too far. What's implemented here is complex. Sounds like you came to this project looking for particular information. What is that? The novel tech? Check out Proof of History.

@ghost
Copy link
Author

ghost commented Feb 8, 2020

You are the first (of 20? ) projects to have such an "overcrowded" readme, and a legal disclaimer.

Anyways, I just came to get a feeling of the codebase, and possibly to try a build. nothing more.

Your readme needs to be reduced, it's scary. Remove the "Introduction" etc., go straight to the "Build from Source" point. Install from binaries is stuff for the manual (just link to it).

What's implemented here is complex.

It is not.

Check out Proof of History.

went already through it, sounds really nice.

@ghost
Copy link
Author

ghost commented Feb 8, 2020

(note that the "readme-problem" is a general one, see e.g.

@mvines mvines added this to the The Future! milestone Feb 9, 2020
@ghost
Copy link
Author

ghost commented Mar 10, 2020

some steps: #8735, #8748

@stale
Copy link

stale bot commented Jun 3, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the stale [bot only] Added to stale content; results in auto-close after a week. label Jun 3, 2021
@stale
Copy link

stale bot commented Jun 16, 2021

This stale issue has been automatically closed. Thank you for your contributions.

@stale stale bot closed this as completed Jun 16, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Apr 4, 2022

This issue has been automatically locked since there has not been any activity in past 7 days after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
locked issue stale [bot only] Added to stale content; results in auto-close after a week.
Projects
None yet
Development

No branches or pull requests

2 participants