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

Update usage section of README for Julia 1.x #673

Merged
merged 2 commits into from
Nov 15, 2019
Merged

Conversation

martinholters
Copy link
Member

Fixes #667.

While at it, fix a broken link in the introduction.

The README was still talking about a line in the `REQUIRE` file. Replace 
that with the respective lines for `Project.toml`. Also remove the 
obsolve `import Compat.String` usage example.
The latest Julia manual has no detailed discussion of packages; it has 
moved to the Pkg.jl docs.
@@ -13,18 +13,21 @@ Compat package provides a macro that lets you use the *latest syntax*
in a backwards-compatible way.

This is primarily intended for use by other [Julia
packages](http://docs.julialang.org/en/latest/manual/packages/), where
packages](https://julialang.github.io/Pkg.jl/v1/creating-packages/), where
Copy link
Member Author

Choose a reason for hiding this comment

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

This could also be https://julialang.github.io/Pkg.jl/v1/managing-packages/ - not sure which one to prefer. Opinions?

@martinholters martinholters added the no changelog Prevent Tagbot from including in release note label Nov 5, 2019
@martinholters
Copy link
Member Author

I'm not too proud of my wording here, but it's definitely an improvement compared to the outdated stuff before, and no-one cared enough to suggest improvements, so...

@martinholters martinholters merged commit 962ba5d into master Nov 15, 2019
@martinholters martinholters deleted the mh/readme-usage branch November 15, 2019 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no changelog Prevent Tagbot from including in release note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Readme needs an update
1 participant