-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- We use a local registry. Therefore some extra steps are required beside the default installation commands.
- Loading branch information
1 parent
29cc6e6
commit 934c62c
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,36 @@ | ||
# QEDevents | ||
|
||
[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) | ||
|
||
|
||
## Installation | ||
|
||
To install the current stable version of `QEDevents.jl` you may use the standard julia package manager within the julia REPL | ||
|
||
```julia | ||
julia> using Pkg | ||
|
||
# add local registry, where QEDevents is registered | ||
julia> Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/QEDjl-project/registry")) | ||
# add general registry again to have it join the local registry | ||
julia> Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/JuliaRegistries/General")) | ||
|
||
julia> Pkg.add("QEDevents") | ||
``` | ||
|
||
or you use the Pkg prompt by hitting `]` within the Julia REPL and then type | ||
|
||
```julia | ||
# add local registry, where QEDevents is registered | ||
(@v1.9) pkg> registry add https://github.com/QEDjl-project/registry | ||
# add general registry again to have it join the local registry | ||
(@v1.9) pkg> registry add https://github.com/JuliaRegistries/General | ||
|
||
(@v1.9) pkg> add QEDevents | ||
``` | ||
|
||
To install the locally downloaded package on Windows, change to the parent directory and type within the Pkg prompt | ||
|
||
```julia | ||
(@v1.9) pkg> add ./QEDevents.jl | ||
``` |