Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Extended the documentation for building NEAR CLI from the source code #430

Merged
merged 2 commits into from
Dec 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
```
Loading