Improve integration README.md with PATH instructions

Open Beginner friendly
#3,634 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust, shell
Domain
documentation, testing

Research direction

Edit integration/README.md. Start by reading its current setup instructions and reproduce the cargo build plus PATH and which hurl flow shown in the issue; document how the snapshot binary is selected, including Windows guidance if it can be confirmed. Done when the README clearly explains the platform-specific steps needed to run integration tests against the built binary.

Written by the indexing model from the issue text.

Description

documentation

We need to make the integration test README clearer about how to update the PATH env so that the snapshot Hurl binary is tested.

$ cd /Users/bob/hurl
$ which hurl
/opt/homebrew/bin/hurl
$ cargo build
$ export PATH=/Users/bob/hurl/target/debug:$PATH
$ which hurl
/Users/bob/hurl/target/debug/hurl

Find instruction for windows ? (Maybe to check with @lepapareil )

Follow-up of #3504 #3628

Dominant language
Rust
Stars
19.2k
Forks
745
Avg merge
5h 3m
Merged PRs (30d)
60

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Orange-OpenSource/hurl

All issues in Orange-OpenSource/hurl

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.