Skip to content

Add README and LICENSE #68

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

Merged
merged 2 commits into from
Nov 4, 2018
Merged

Add README and LICENSE #68

merged 2 commits into from
Nov 4, 2018

Conversation

fredrikekre
Copy link
Member

Add README and LICENSE to make it possible to splice in the package README.md and LICENSE.md in docstrings.

@fredrikekre fredrikekre changed the title Add README and LICENSE to make it possible to splice in Add README and LICENSE Nov 2, 2018
@fredrikekre fredrikekre requested a review from mortenpi November 3, 2018 00:06
Copy link
Member

@mortenpi mortenpi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Needs docs though.

Also, a thing to note is that GitHub flavored Markdown is a bit different from what the Julia parser expects, so the document may not look the way it should when included with README (e.g. the [][] link shortcuts are not supported in Julia).

@mortenpi mortenpi added this to the 0.6.0 milestone Nov 3, 2018
@fredrikekre
Copy link
Member Author

Also, a thing to note is that GitHub flavored Markdown is a bit different from what the Julia parser expects, so the document may not look the way it should when included with README (e.g. the [][] link shortcuts are not supported in Julia).

Right, I'll add a note in the docs about this, but this should at least replicate the behavior lost in JuliaLang/julia#25772

the package README.md and LICENSE.md in docstrings.
@fredrikekre fredrikekre merged commit 1668567 into master Nov 4, 2018
@fredrikekre fredrikekre deleted the fe/readme branch November 4, 2018 01:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants