Skip to content

Commit

Permalink
Add registered installation instructions (#161)
Browse files Browse the repository at this point in the history
  • Loading branch information
gdalle authored Apr 8, 2024
1 parent 8eb3bda commit e3bc10d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
10 changes: 9 additions & 1 deletion DifferentiationInterface/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ We also provide some experimental backends ourselves:

## Installation

In a Julia REPL, run
Until the package is registered, you need to install it from the GitHub repo:

```julia
julia> using Pkg
Expand All @@ -64,6 +64,14 @@ julia> Pkg.add(
)
```

Once the package is registered, you will be able to do:

```julia
julia> using Pkg

julia> Pkg.add("DifferentiationInterface")
```

## Example

```jldoctest readme
Expand Down
10 changes: 9 additions & 1 deletion DifferentiationInterfaceTest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Make it easy to know, for a given function:

## Installation

In a Julia REPL, run
Until the package is registered, you need to install it from the GitHub repo:

```julia
julia> using Pkg
Expand All @@ -44,3 +44,11 @@ julia> Pkg.add(
subdir="DifferentiationInterfaceTest"
)
```

Once the package is registered, you will be able to do:

```julia
julia> using Pkg

julia> Pkg.add("DifferentiationInterfaceTest")
```

0 comments on commit e3bc10d

Please sign in to comment.