Skip to content

Commit

Permalink
docs: Extended the documentation for building NEAR CLI from the sourc…
Browse files Browse the repository at this point in the history
…e code (#430)

Closes #429

@race-of-sloths include
  • Loading branch information
frol authored Dec 23, 2024
1 parent 3fc78b6 commit 5927f4b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ https://github.com/user-attachments/assets/4a7e4633-1957-4dc2-a032-827fa9c06c29

Install it with `cargo`, just make sure you have [Rust](https://rustup.rs) installed on your computer.

> NOTE: On Linux, near-cli-rs is built with Ledger devices support by default, and that requires `libudev-dev` package. On Debian/Ubuntu, install it with `apt install libudev-dev`.
```bash
cargo install near-cli-rs
```
Expand Down
9 changes: 6 additions & 3 deletions docs/README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,12 @@ You can learn more about working with the configuration file [here](GUIDE.en.md#

## Building

_near CLI_ is written in Rust, so you'll need to install
Prerequisites:

* _near CLI_ is written in Rust, so you'll need to install
[Rust](https://www.rust-lang.org/) in order to compile it.
_near CLI_ compiles with Rust 1.64.0 (stable) or newer. In general, _near CLI_ tracks the latest stable release of the Rust compiler.
_near CLI_ compiles with Rust 1.80.0 (stable) or newer. In general, _near CLI_ tracks the latest stable release of the Rust compiler.
* libudev-dev (Debian/Ubuntu: `apt install libudev-dev`)

To build _near CLI_:

Expand All @@ -79,5 +82,5 @@ $ git clone https://github.com/near/near-cli-rs.git
$ cd near-cli-rs
$ cargo build --release
$ ./target/release/near --version
near 0.2.4
near 0.17.0
```

0 comments on commit 5927f4b

Please sign in to comment.