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.

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

Use smesh_jll #7

Merged
merged 7 commits into from
Jan 26, 2024
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Update README
sloede committed Jan 26, 2024
commit 01009d23e83af6cc10cf894e2a0c9832e91f5ec7
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -19,21 +19,17 @@ operating system](https://julialang.org/downloads/platform/).
[Smesh.jl](https://github.com/trixi-framewor/Smesh.jl) works with Julia v1.8
and later on Linux, macOS and Windows platforms.

To use Smesh.jl, you currently need to manually install the underlying Fortran package smesh
(note that this is subject to change in the near future). For installation instructions,
please follow the README in the [smesh](https://github.com/trixi-framework/smesh)
repository.

### Installation
Since Smesh.jl is a not registered Julia package yet, you can install it by executing
the following commands in the Julia REPL:
```julia
julia> import Pkg; Pkg.add("https://github.com/trixi-framework/Smesh.jl")
```

To make use of the local smesh build, you need to tell Smesh.jl where to find the library.
For this, create a `LocalPreferences.toml` file next to your `Project.toml` for the project
in which you use Smesh.jl. It should have the following content:
By default, Smesh.jll uses pre-compiled binaries of the smesh package that will get
automatically installed when obtaining Smesh.jl. However, you can also make use of a local
smesh build. For this, create a `LocalPreferences.toml` file next to your `Project.toml`
for the project in which you use Smesh.jl. It should have the following content:

* On Linux:
```toml