From 1937e8e7e5685943002d8d82e917daf9dec9a150 Mon Sep 17 00:00:00 2001 From: raphjaph Date: Sun, 17 Mar 2024 17:42:51 -0700 Subject: [PATCH 1/2] Clarify build instructions --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 2db3362b05..d9577927a6 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,16 @@ cd ord cargo build --release ``` +By default this builds the `master` branch, which is under heavy development. If +you wish to build a specific version do: + +``` +git clone https://github.com/ordinals/ord.git +cd ord +git checkout +cargo build --release +``` + Once built, the `ord` binary can be found at `./target/release/ord`. `ord` requires `rustc` version 1.67.0 or later. Run `rustc --version` to ensure you have this version. Run `rustup update` to get the latest stable release. From 3f79939452386581b58e8788b943956a1c01b1d3 Mon Sep 17 00:00:00 2001 From: raphjaph Date: Sun, 17 Mar 2024 17:47:46 -0700 Subject: [PATCH 2/2] Amend --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d9577927a6..3ce34f8fec 100644 --- a/README.md +++ b/README.md @@ -99,21 +99,22 @@ You'll also need Rust: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh ``` -To build `ord` from source: +Clone the `ord` repo: ``` git clone https://github.com/ordinals/ord.git cd ord -cargo build --release ``` -By default this builds the `master` branch, which is under heavy development. If -you wish to build a specific version do: +To build a specific version of `ord`, first checkout that version: ``` -git clone https://github.com/ordinals/ord.git -cd ord git checkout +``` + +And finally to actually build `ord`: + +``` cargo build --release ```