Skip to content

Commit

Permalink
fix: use locked Cargo.lock for installation
Browse files Browse the repository at this point in the history
This PR adds `--locked` to the installation command
`cargo instal --locked --path .`. This flag locks Cargo.lock.

Without this flag, rust will actually update the dependencies prior to
installing the binaries. If someone upstream introduces a backwards-
incompatible error, we are stuck with the compilation errors.

Co-authored-by: Ferdinand Sauer <ferdinand@neptune.cash>
  • Loading branch information
aszepieniec and jan-ferdinand committed Feb 13, 2024
1 parent fcb306f commit 9422027
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Neptune-core is the reference implementation for the [Neptune](https://neptune.c
- Enter the repository: `cd neptune-core`
- Checkout the release branch `git checkout release`. (Alternatively, for the *unstable development* branch, skip this step.)

- Build for release and put the binaries in your local path (`~/.cargo/bin/`): `cargo install --path .` (needs at least 3 GB of RAM and a few minutes)
- Build for release and put the binaries in your local path (`~/.cargo/bin/`): `cargo install --locked --path .` (needs at least 3 GB of RAM and a few minutes)

### Windows

Expand All @@ -28,7 +28,7 @@ With a functioning version of cargo, compilation on Windows should just work out
- Enter the repository: `cd neptune-core`
- Checkout the release branch `git checkout release`. (Alternatively, for the *unstable development* branch, skip this step.)

- Run `cargo install --path .`
- Run `cargo install --locked --path .`


## Running & Connecting
Expand Down

0 comments on commit 9422027

Please sign in to comment.