-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ecc6cbf
commit 79a1e70
Showing
1 changed file
with
32 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,35 @@ | ||
# QEDprocesses | ||
|
||
[![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 `QEDprocesses.jl` you may use the standard julia package manager within the julia REPL | ||
|
||
```julia | ||
julia> using Pkg | ||
|
||
# add local registry, where QEDprocesses 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("QEDprocesses") | ||
``` | ||
|
||
or you use the Pkg prompt by hitting `]` within the Julia REPL and then type | ||
|
||
```julia | ||
# add local registry, where QEDprocesses 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 QEDprocesses | ||
``` | ||
|
||
To install the locally downloaded package on Windows, change to the parent directory and type within the Pkg prompt | ||
|
||
```julia | ||
(@v1.9) pkg> add ./QEDprocesses.jl | ||
``` |