Skip to content

Commit

Permalink
small README corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
consolethinks committed Jun 28, 2024
1 parent 0df1ed6 commit ea994d0
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,14 @@ These commands bear the same names as the former executables. The general syntax
Furthermore, the use of single hyphen, multi-letter flags is now discontinued, as it went against general convention. So, in practical terms, `-[long_flag_name]` and `--[long_flag_name]` were both accepted, but now only the latter is accepted.

### Backwards compatibility with v2
A set of shell scripts are included with the Linux and Mac versions of releases in order to maintain compatibility with preexisting automation scripts.
A set of shell scripts are included with releases that are compatible with Linux and Mac executables in order to maintain compatibility with preexisting automation scripts.
As these are written in BASH, Windows is not supported unless WSL2 is used.

Useful informations:
- The scripts can be found on the [Releases](https://github.com/paulscherrerinstitute/scicat-cli/releases) page, under scicat-cli_V2Scripts-[VERSION].tar.gz.

- The scripts and the scicat-cli executable **must** be kept in the **same folder** for them to work.

- The scripts will still accept single hyphen flags as well.
Usage informations:
- The scripts can be found on the [Releases](https://github.com/paulscherrerinstitute/scicat-cli/releases) page, under scicat-cli_V2Scripts-[VERSION].tar.gz
- Just extract the archive into the folder with the scicat-cli executable
- The scripts and the scicat-cli executable **must** be kept in the **same folder** for them to work
- The scripts will still accept single hyphen flags as well

## Deployment

Expand Down

0 comments on commit ea994d0

Please sign in to comment.