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.

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

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

Merged
merged 2 commits into from
Nov 15, 2019
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
375ab57
Update `Usage` section of README to Julia 1.x
martinholters Nov 5, 2019
b903713
Replace dead link in README
martinholters Nov 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?

it is important to maintain cross-version compatibility.

## Usage

To use Compat in your Julia package, add a line `Compat` to the
`REQUIRE` file in your package directory. Then, in your package,
shortly after the `module` statement include lines like these:
To use Compat in your Julia package, add a line
`Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"` in the `[deps]` section
and a line `Compat = "..."` in the `[compat]`section to the `Project.toml` file
in your package directory. The version in the latter should be the minimum
version that supports all needed fatures (see list below), and (if applicable)
any newer major versions verified to be compatible. Then, in your package,
shortly after the `module` statement a line like this:

```julia
using Compat
import Compat.String
```

and then as needed add
Expand Down