Skip to content

Commit 46c507c

Browse files
committed
update compile README
1 parent 883215d commit 46c507c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

compile/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ Minimal C bindings for JetReconstruction.jl
1010
To build the library, run the following command from the package root directory:
1111

1212
```sh
13-
julia --project=compile compile/build.jl
13+
julia --project=compile compile/build.jl --output-dir JetReconstructionCompiled
1414
```
1515

1616
> [!NOTE]
17-
> Since Julia 1.12 `--juliac` can be specified to use the juliac compiler instead of PackageCompiler.
18-
> Before Julia 1.12, nightlies can be used instead:
17+
> Since Julia 1.12 `--juliac` can be specified to use the juliac compiler instead of PackageCompiler.
18+
> Before Julia 1.12, nightlies can be used instead (make sure to instantiate the main JetReconstruction and `compile` projects with the same version of Julia):
1919
>
2020
> ```sh
2121
> julia +nightly --project=compile compile/build.jl --juliac
2222
> ```
2323
>
24-
> Packes compiled with `PackageCompiler.jl` will have `JETRECONSTRUCTION_COMPILER_PACKAGECOMPILER` defined. Packages compiled with `juliac` will have `JETRECONSTRUCTION_COMPILER_JULIAC` defined.
24+
> Packages compiled with `PackageCompiler.jl` will have `JETRECONSTRUCTION_COMPILER_PACKAGECOMPILER` defined. Packages compiled with `juliac` will have `JETRECONSTRUCTION_COMPILER_JULIAC` defined.
2525
2626
## Usage example
2727
@@ -76,7 +76,7 @@ int main(int argc, char *argv[]) {
7676
To build an example application run the following command:
7777
7878
```shell
79-
cc -o jetreconstruction_test compile/test/jetreconstruction_test.c -IJetReconstructionCompiled/include -LJetReconstructionCompiled/lib -ljetreconstruction -ljulia
79+
cc -o jetreconstruction_test compile/downstream/jetreconstruction_test.c -IJetReconstructionCompiled/include -LJetReconstructionCompiled/lib -ljetreconstruction
8080
```
8181
8282
In case the compiled library resides in non-standard location, add its location to `LD_LIBRARY_PATH` when running example application:

0 commit comments

Comments
 (0)