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: mentions app dir and its location #74

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from 2 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
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ Before you begin, ensure you have met the following requirements:

- **Rust**: Install Rust using [rustup](https://rustup.rs/):

```
``` shell
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

- Update Rust to the latest version:

```
``` shell
rustup update
```

Expand All @@ -58,36 +58,42 @@ To install Dash Evo Tool:

1. **Clone the repository**:

```
``` shell
git clone https://github.com/dashpay/dash-evo-tool.git
```

2. **Navigate to the project directory**:

```
``` shell
cd dash-evo-tool
```

3. **Build the project**:

```
``` shell
cargo build --release
```

## Getting Started

### Create `.env` File

Create a new file in the root of the dash-evo-tool directory named `.env` and copy the contents of `.env.example` into it. No changes to the file are necessary in this version.

### Start the App

Run the application using:

```
``` shell
cargo run
```

### Application directory

When the application runs for the first time, it creates a application directory and stores an `.env` file in it (based on [`.env.example`](.env.example)). It also stores application data in the directory. If you need to update the `.env` file, locate it in the application directory for your Operating System:

| Operating System | Application Directory Path |
| - | - |
| macOS | `~/Library/Application Support/Dash-Evo-Tool/` |
| Windows | `C:\Users\<User>\AppData\Roaming\Dash-Evo-Tool\config` |
| Linux | `/home/<user>/.config/dash-evo-tool/` |

### Connect to a Network

1. **Open Network Chooser**: In the app, navigate to the **Network Chooser** screen.
Expand Down