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

Rework Readme #368

Open
Frijol opened this issue Feb 11, 2018 · 7 comments
Open

Rework Readme #368

Frijol opened this issue Feb 11, 2018 · 7 comments

Comments

@Frijol
Copy link
Member

Frijol commented Feb 11, 2018

Our readme has gotten really long, to the extent that it's probably not helpful anymore. I'm taking a look at how we can make it shorter and more up to date. Will keep notes here.

@Frijol
Copy link
Member Author

Frijol commented Feb 11, 2018

Duplication of information. What's a Tessel/What's the Project About/How Can I Get Involved are really Website/Mission/Contributing. These sections should link to their respective pages instead of summarizing again. Relevant content from the readme should move into the individual pages.

@Frijol
Copy link
Member Author

Frijol commented Feb 11, 2018

Contribute section is confusing, let's label it "Donate" or something– in an open source context, contribute is an ambiguous term

@Frijol
Copy link
Member Author

Frijol commented Feb 11, 2018

"Read more" section– is this useful?

@Frijol
Copy link
Member Author

Frijol commented Feb 11, 2018

"Reach out"– would it be more appropriate to link to tessel.io/community?

@Frijol
Copy link
Member Author

Frijol commented Feb 11, 2018

"Current goals" – Is this the appropriate place to keep this information? Maybe yes. Maybe this should be the meat of the Readme.

@Frijol
Copy link
Member Author

Frijol commented Feb 11, 2018

Ugh. Not sure I'm going about this well. What is it we need to convey in the Readme to this repo? Likely more useful to start with "What are people trying to learn when they visit this page?" rather than back-work from "why do we have all this". Any suggestions?

@Frijol
Copy link
Member Author

Frijol commented Feb 11, 2018

Relevant: #355

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant