Skip to content

Commit

Permalink
Format and spellcheck README.maintainer.md (#1291)
Browse files Browse the repository at this point in the history
Structure README.maintainer.md a little bit
  • Loading branch information
albinahlback authored Mar 14, 2023
1 parent f212a51 commit 619ff93
Showing 1 changed file with 31 additions and 11 deletions.
42 changes: 31 additions & 11 deletions README.maintainer.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# Directions for overriding the C libraries (flint)
# Directions for overriding the C libraries

In `.julia/artifacts` you should have or make a file `Overrides.toml` with the following
entry (replace `/usr/local` with the location of your installation)
## FLINT

In `.julia/artifacts` you should have or make a file `Overrides.toml` with the
following entry (replace `/usr/local` with the location of your installation)

```
[e134572f-a0d5-539d-bddf-3cad8db41a82]
FLINT = "/usr/local"
```

The UUID is that of `FLINT_jll`, which is available in Nemo's `Project.toml`.
Note the case sensitivity of the artifact name: if the jll is called `XxX_jll`, the entry should be `XxX = `.
This is all that is needed to override the flint location. If it has worked:
Note the case sensitivity of the artifact name: if the jll is called `XxX_jll`,
the entry should be `XxX = `. This is all that is needed to override the FLINT
location. If it has worked:

```
julia> using Nemo
Expand All @@ -20,18 +23,35 @@ julia> Nemo.libflint

Troubleshooting guide:

- If setting up the override for the first time, Nemo should be re-precompiled. This can be triggered by touching a source file.
- Several of the other libraries depending on flint might want a specific so version. This can be tweaked by hacking the flint makefile.
- If setting up the override for the first time, Nemo should be re-precompiled.
This can be triggered by touching a source file.

- Several of the other libraries depending on FLINT might want a specific
so-version of FLINT. This can be tweaked by hacking the FLINT makefile.

## arb
## Arb

This should set `Nemo.libarb`.
For Arb, adapt the following entry for `Overrides.toml`:

```
[d9960996-1013-53c9-9ba4-74a4155039c3]
Arb = "/usr/local"
```

## antic
## Antic

For Antic, adapt the following entry for `Overrides.toml`:

```
[e21ec000-9f72-519e-ba6d-10061e575a27]
Antic = "/usr/local"
```

## Calcium

For Calcium, adapt the following entry for `Overrides.toml`:

## calcium
```
[fcfa6d1b-d8ce-59d5-8c0a-c0d7f69e4f40]
Calcium = "/usr/local"
```

0 comments on commit 619ff93

Please sign in to comment.