From 11604fdc4e6d1d270e5beb8e0579d692d93820b6 Mon Sep 17 00:00:00 2001 From: thephez Date: Wed, 27 Nov 2024 11:21:38 -0500 Subject: [PATCH 1/2] docs: add dependency install instructions Previously not all required dependencies were listed so builds failed for some users --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 08536ca57..34a58c03d 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,25 @@ Before you begin, ensure you have met the following requirements: rustup update ``` +### Dependencies + +- Install build-essential tools, SSL development libraries, and other required dependencies. On +Ubuntu, use: + + ``` shell + sudo apt install -y build-essential libssl-dev pkg-config unzip + ``` + + On other Unix-like systems, use the equivalent package management commands. + +- Install Protocol Buffers Compiler (protoc). Download the appropriate protoc binary for your +system, unzip, and install: + + ``` shell + wget https://github.com/protocolbuffers/protobuf/releases/download/v26.1/protoc-26.1-linux-x86_64.zip + sudo unzip protoc-*-linux-x86_64.zip -d /usr/local + ``` + ### Dash Core Wallet Setup - **Dash Core Wallet**: Download and install from [dash.org/wallets](https://www.dash.org/wallets/). From 93f2e22e5919247ecf57da7407213c92190807fc Mon Sep 17 00:00:00 2001 From: thephez Date: Wed, 27 Nov 2024 11:22:24 -0500 Subject: [PATCH 2/2] docs: update toc and some formatting --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 34a58c03d..d3ba2043c 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,12 @@ The tool supports both Mainnet and Testnet networks. Check out the [documentatio - [Prerequisites](#prerequisites) - [Rust Installation](#rust-installation) + - [Dependencies](#dependencies) - [Dash Core Wallet Setup](#dash-core-wallet-setup) - [Installation](#installation) - [Getting Started](#getting-started) - [Start the App](#start-the-app) + - [Application directory](#application-directory) - [Connect to a Network](#connect-to-a-network) - [Usage](#usage) - [Register a DPNS Username](#register-a-dpns-username) @@ -204,19 +206,19 @@ Contributions are welcome! - **Create a Branch**: - ``` + ``` shell git checkout -b feature/YourFeatureName ``` - **Commit Changes**: Make your changes and commit them with descriptive messages. - ``` + ``` shell git commit -m "Add feature: YourFeatureName" ``` - **Push to Branch**: - ``` + ``` shell git push origin feature/YourFeatureName ```