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.

Sign up for GitHub

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

Jump to bottom

Implement a .shed.yml 2 README.md command. #581

Open

jmchilton opened this issue Sep 26, 2016 · 0 comments

Member

jmchilton commented Sep 26, 2016 •

edited

Loading

Use description and long_description to assemble the core of the README.md.
Use repository url to build lists of tools and links in Markdown.
Optionally add some basic usage information based on all of this (how to clone, test, serve, update, etc...).

Consider a few more .shed.yml fields to enhance both README and shed recording - such as license information, contributing, etc....

jmchilton changed the title ~~.shed.yml 2 README~~ Implement a .shed.yml 2 README.md command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment