Skip to content

Commit

Permalink
Swap order of install and usage in README to improve clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
lbianchi-lbl committed Apr 9, 2024
1 parent cbb2ff0 commit 219d471
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,12 @@ For example, when supporting a user who's reporting an issue, a WaterTAP develop
- Automating the collection of information (as opposed to the maintainer having to provide the commands to run, and the user having to run them)
- Collating the output in a standardized text format, so that e.g. outputs from different environments can be compared (or even `diff`ed) directly
## How do I install getinfo?
To use **getinfo**, no installation is necessary (or, for the time being, even supported). **getinfo** is designed to be as self-contained as possible: the only requirements are (a) a local copy of the `getinfo.py` file, and (b) a working `python` command.
## How do I use getinfo?
1. Download `getinfo.py` from the following link: https://github.com/watertap-org/getinfo/raw/main/getinfo.py
2. Open a terminal/command prompt and run `python getinfo.py`
3. Copy the output and paste it where needed, e.g. a GitHub issue or a Slack support message
## How do I install getinfo?
To use **getinfo**, no installation is necessary (or, for the time being, even supported). **getinfo** is designed to be as self-contained as possible: the only requirements are (a) a local copy of the `getinfo.py` file, and (b) a working `python` command.

0 comments on commit 219d471

Please sign in to comment.