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

Hyperlink from README.md to license file #52

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

aspiers
Copy link

@aspiers aspiers commented Apr 8, 2016

If we're using a Markdown README, the license file can be a hyperlink,
so that when the Markdown is rendered (e.g. on github), the link can
be clicked to jump to the README.

Also put the filename in a monospaced font.

@aspiers
Copy link
Author

aspiers commented Apr 8, 2016

BTW I wasn't sure whether the yard version should also be changed - I'm not familiar with yard yet.

@postmodern
Copy link
Member

YARD has it's own weird way of linking to files, since raw files are prefixed by file.. Could you also make similar changes to the .rdoc and .tt READMEs?

If we're using a Markdown README, the license file can be a hyperlink,
so that when the Markdown is rendered (e.g. on github), the link can
be clicked to jump to the README.

Also put the filename in a monospaced font.
@aspiers
Copy link
Author

aspiers commented Aug 2, 2017

@postmodern Is that better?

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

Successfully merging this pull request may close these issues.

2 participants