From 505e820716d0a3bcbb3e71c88e4b09ee9cc64507 Mon Sep 17 00:00:00 2001 From: Chris Date: Fri, 11 Oct 2024 09:24:16 -0600 Subject: [PATCH] Include lld instructions in README.md Implement @ephraim271's suggestion. Fixes #353 . --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 5daf9bb1..b5b7a0bc 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,10 @@ To install Nyx, follow these steps: 2. Navigate to the directory: `cd nyx` 3. Run any of the [examples](./examples/), e.g. `RUST_LOG=info cargo run --example 01_orbit_prop --release` +#### Compilation + +Nyx uses `lld`, the LLVM linker, for faster compilation times. You may need to manually install `lld` depending on your distribution. On Ubuntu, this command is `sudo apt install clang lld`. + ### Python For Python projects, get started by installing the library via `pip`: `pip install nyx_space`.