From 6f78fef6047886c5ce3a3aa1b0bee99157a554d7 Mon Sep 17 00:00:00 2001 From: I-Al-Istannen Date: Wed, 4 Nov 2020 22:08:33 +0100 Subject: [PATCH] Add quoting instructions to README --- .github/workflows/package.yml | 2 +- README.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/package.yml b/.github/workflows/package.yml index c451789..c217735 100644 --- a/.github/workflows/package.yml +++ b/.github/workflows/package.yml @@ -67,7 +67,7 @@ jobs: - name: "Upload release artifacts" uses: softprops/action-gh-release@v1 with: - body: "Download the correct sync_url for your platform and run it in the terminal or CMD. You might need to make it executable on Linux/Mac with `chmod +x `." + body: "Download the correct sync_url for your platform and run it in the terminal or CMD. You might need to make it executable on Linux/Mac with `chmod +x `. Also please *quote the url you pass to the program* or your shell might silently screw it up!" files: | pferd_sync_url_mac pferd_sync_url_linux diff --git a/README.md b/README.md index a1cd1dd..d82f557 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,8 @@ use, but doesn't expose all the configuration options and tweaks a full install does. 1. Download the `sync_url` binary from the [latest release](https://github.com/Garmelon/PFERD/releases/latest). -2. Run the binary in your terminal (`./sync_url` or `sync_url.exe` in the CMD) to see the help and use it. I'd recommend using the `--cookies` option. +2. Recognize that you most likely need to enclose the URL in `''` quotes to prevent your shell from interpreting `&` and other symbols +3. Run the binary in your terminal (`./sync_url` or `sync_url.exe` in the CMD) to see the help and use it. I'd recommend using the `--cookies` option. If you are on **Linux/Mac**, you need to *make the file executable* using `chmod +x `. If you are on **Mac**, you need to allow this unverified program to run (see e.g. [here](https://www.switchingtomac.com/tutorials/osx/how-to-run-unverified-apps-on-macos/))