Skip to content

Update install instructions in README.md #98

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.

Sign up for GitHub

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

Merged
sleaux merged 4 commits into from
Apr 30, 2025
Merged

Update install instructions in README.md #98

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
28ab9fd
Update README.md
sleaux Apr 30, 2025
f5d80cd
typo
sleaux Apr 30, 2025
d89bd8d
split commands
sleaux Apr 30, 2025
a3e3565
clarify x86
sleaux Apr 30, 2025
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
19 changes: 16 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,20 +65,31 @@ Please include the following:

## Dependencies

This project is built to run on linux. It is tested on Ubuntu 18.04.
This project is built to run on linux. It is tested on Ubuntu 24.04 x86.

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

## Installation

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

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

```bash
wget https://github.com/mongodb/mongo-task-generator/releases/download/v0.1.0/mongo-task-generator
wget https://github.com/mongodb/mongo-task-generator/releases/latest/download/mongo-task-generator
```

## Building from source
If you aren't on a system the Ubuntu 24.04 x86 release is compatible with, you can build from source:

```bash
git clone https://github.com/mongodb/mongo-task-generator.git
cd mongo-task-generator
rustup run 1.81 cargo build --release

./target/release/mongo-task-generator --help
```

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

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

You may want to pin the rust toolchain to the same one we use to test/release: `rustup default 1.81`

### linting/formatting

```bash
Expand Down