Skip to content

Commit bd69038

Browse files
sleauxsmcclure15
andauthored
Update install instructions in README.md (#98)
Co-authored-by: Steve McClure <steve.mcclure@mongodb.com>
1 parent 739f734 commit bd69038

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -65,20 +65,31 @@ Please include the following:
6565

6666
## Dependencies
6767

68-
This project is built to run on linux. It is tested on Ubuntu 18.04.
68+
This project is built to run on linux. It is tested on Ubuntu 24.04 x86.
6969

7070
The [evergreen CLI](https://docs.devprod.prod.corp.mongodb.com/evergreen/CLI) is
7171
required.
7272

7373
## Installation
7474

7575
The tool can be downloaded from the [github releases](https://github.com/mongodb/mongo-task-generator/releases)
76-
page. It is currently built on Ubuntu 20.04 and should work on recent x86 linux distributions.
76+
page. It is currently built on Ubuntu 24.04 x86.
7777

7878
The install can be automated using a tool like `wget` or `curl`:
7979

8080
```bash
81-
wget https://github.com/mongodb/mongo-task-generator/releases/download/v0.1.0/mongo-task-generator
81+
wget https://github.com/mongodb/mongo-task-generator/releases/latest/download/mongo-task-generator
82+
```
83+
84+
## Building from source
85+
If you aren't on a system the Ubuntu 24.04 x86 release is compatible with, you can build from source:
86+
87+
```bash
88+
git clone https://github.com/mongodb/mongo-task-generator.git
89+
cd mongo-task-generator
90+
rustup run 1.81 cargo build --release
91+
92+
./target/release/mongo-task-generator --help
8293
```
8394

8495
## Usage
@@ -156,6 +167,8 @@ Make sure you have a rust development environment installed. See instructions [h
156167

157168
From the root of the repository, run `cargo build` to build the project.
158169

170+
You may want to pin the rust toolchain to the same one we use to test/release: `rustup default 1.81`
171+
159172
### linting/formatting
160173

161174
```bash

0 commit comments

Comments
 (0)