Skip to content

Commit

Permalink
Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
GianlucaFuwa committed Mar 11, 2024
1 parent 4b5754c commit 6d822d7
Show file tree
Hide file tree
Showing 24 changed files with 517 additions and 977 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,14 @@ Inspired by the [LatticeQCD.jl](https://github.com/akio-tomiya/LatticeQCD.jl/tre
## Installation:
First make sure you have a Julia version at or above 1.9.0 installed. You can use [juliaup](https://github.com/JuliaLang/juliaup) for that or just install the release from the [Julia website](https://julialang.org/downloads/).

The package in not in the general registry. So you will have to:
The package in not in the general registry. So you will have to either
- Add the package to your Julia environment via:
```
julia> ] add https://github.com/GianlucaFuwa/MetaQCD.jl
```

or

1. Clone this repository onto your machine.
2. Open Julia in the directory which you cloned the repo into, with the project specific environment. This can either be done by starting Julia with the command line argument "--project" or by activating the environment within an opened Julia instance via the package manager:
``` julia
Expand Down
Loading

0 comments on commit 6d822d7

Please sign in to comment.