Skip to content

Fix links in docs #41

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.

Sign up for GitHub

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

Merged
sloede merged 2 commits into from
Jul 3, 2023
Merged

Fix links in docs #41

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9cb0511
Fix links in docs
sloede Jul 3, 2023
040eeff
Reflow text
sloede Jul 3, 2023
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
8 changes: 5 additions & 3 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,10 @@ For building, `cmake` and its typical workflow is used.
### Setting up Julia
After the library has been installed, you need to configure Julia for use with libtrixi. For
this, create a directory where all necessary files will be placed, e.g., `libtrixi-julia`.
Then, you can use the [`utils/libtrixi-init-julia`](utils/libtrixi-init-julia) tool (also
available at `<install_directory>/bin`) to do the rest for you. A minimal example would be:
Then, you can use the
[`utils/libtrixi-init-julia`](https://github.com/trixi-framework/libtrixi/tree/main/utils/libtrixi-init-julia)
tool (also available at `<install_directory>/bin`) to do the rest for you. A minimal example
would be:

```shell
mkdir libtrixi-julia
Expand Down Expand Up @@ -198,7 +200,7 @@ If you change the executable name from `simple_trixi_controller_c` to
`simple_trixi_controller_f`, you will get a near identical output. The corresponding source
files `simple_trixi_controller.c` and `simple_trixi_controller.f90` give you an idea on how
to use the C and Fortran APIs of libtrixi, and can be found in the
[`examples/`](examples/) folder.
[`examples/`](https://github.com/trixi-framework/libtrixi/tree/main/examples/) folder.

If you just want to test the Julia part of libtrixi, i.e., LibTrixi.jl, you can also run
everything from Julia. From the repository root, execute
Expand Down