READMEs: update ${HOME}/Work

xpack-dev-tools · Jan 19, 2022 · 0b688e3 · 0b688e3
1 parent aa9ab01
commit 0b688e3
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 47 deletions.
diff --git a/README-BUILD.md b/README-BUILD.md
@@ -68,11 +68,11 @@ Git repo.
 To download them, issue the following commands:
 
 ```sh
-rm -rf ~/Downloads/qemu-arm-xpack.git; \
+rm -rf ${HOME}/Work/qemu-arm-xpack.git; \
 git clone \
   https://github.com/xpack-dev-tools/qemu-arm-xpack.git \
-  ~/Downloads/qemu-arm-xpack.git; \
-git -C ~/Downloads/qemu-arm-xpack.git submodule update --init --recursive
+  ${HOME}/Work/qemu-arm-xpack.git; \
+git -C ${HOME}/Work/qemu-arm-xpack.git submodule update --init --recursive
 ```
 
 > Note: the repository uses submodules; for a successful build it is
@@ -82,12 +82,12 @@ For development purposes, clone the `xpack-develop`
 branch:
 
 ```sh
-rm -rf ~/Downloads/qemu-arm-xpack.git; \
+rm -rf ${HOME}/Work/qemu-arm-xpack.git; \
 git clone \
   --branch xpack-develop \
   https://github.com/xpack-dev-tools/qemu-arm-xpack.git \
-  ~/Downloads/qemu-arm-xpack.git; \
-git -C ~/Downloads/qemu-arm-xpack.git submodule update --init --recursive
+  ${HOME}/Work/qemu-arm-xpack.git; \
+git -C ${HOME}/Work/qemu-arm-xpack.git submodule update --init --recursive
 ```
 
 ## The `Work` folder
@@ -166,7 +166,7 @@ Before running a build for the first time, it is recommended to preload the
 docker images.
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh preload-images
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh preload-images
 ```
 
 The result should look similar to:
@@ -201,14 +201,14 @@ network connection or a computer entering sleep.
 screen -S qemu
 
 sudo rm -rf ~/Work/qemu-arm-*
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh --develop --all
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh --develop --all
 ```
 
 or, for development builds:
 
 ```sh
 sudo rm -rf ~/Work/qemu-arm-*
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh --develop--without-pdf --without-html --disable-tests --linux64 --win64
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh --develop--without-pdf --without-html --disable-tests --linux64 --win64
 ```
 
 To detach from the session, use `Ctrl-a` `Ctrl-d`; to reattach use
@@ -251,7 +251,7 @@ Before running a build for the first time, it is recommended to preload the
 docker images.
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh preload-images
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh preload-images
 ```
 
 The result should look similar to:
@@ -271,14 +271,14 @@ network connection or a computer entering sleep.
 screen -S qemu
 
 sudo rm -rf ~/Work/qemu-arm-*
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh --develop --all
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh --develop --all
 ```
 
 or, for development builds:
 
 ```sh
 sudo rm -rf ~/Work/qemu-arm-*
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh --develop --without-pdf --without-html --disable-tests --arm32 --arm64
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh --develop --without-pdf --without-html --disable-tests --arm32 --arm64
 ```
 
 To detach from the session, use `Ctrl-a` `Ctrl-d`; to reattach use
@@ -319,14 +319,14 @@ network connection or a computer entering sleep.
 screen -S qemu
 
 rm -rf ~/Work/qemu-arm-*
-caffeinate bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh --develop --macos
+caffeinate bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh --develop --macos
 ```
 
 or, for development builds:
 
 ```sh
 rm -rf ~/Work/qemu-arm-*
-caffeinate bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh --develop --without-pdf --without-html --disable-tests --macos
+caffeinate bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh --develop --without-pdf --without-html --disable-tests --macos
 ```
 
 To detach from the session, use `Ctrl-a` `Ctrl-d`; to reattach use
@@ -363,19 +363,19 @@ On Arm, instead of `--all`, you can use any combination of:
 To remove most build temporary files, use:
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh --all clean
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh --all clean
 ```
 
 To also remove the library build temporary files, use:
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh --all cleanlibs
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh --all cleanlibs
 ```
 
 To remove all temporary files, use:
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh --all cleanall
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh --all cleanall
 ```
 
 Instead of `--all`, any combination of `--win64 --linux64`

diff --git a/README-DEVELOP.md b/README-DEVELOP.md
@@ -171,23 +171,23 @@ Git repo.
 To download them, use:
 
 ```sh
-rm -rf ~/Downloads/qemu-arm-xpack.git; \
+rm -rf ${HOME}/Work/qemu-arm-xpack.git; \
 git clone \
   https://github.com/xpack-dev-tools/qemu-arm-xpack.git \
-  ~/Downloads/qemu-arm-xpack.git; \
-git -C ~/Downloads/qemu-arm-xpack.git submodule update --init --recursive
+  ${HOME}/Work/qemu-arm-xpack.git; \
+git -C ${HOME}/Work/qemu-arm-xpack.git submodule update --init --recursive
 ```
 
 For development purposes, clone the `xpack-develop`
 branch:
 
 ```sh
-rm -rf ~/Downloads/qemu-arm-xpack.git; \
+rm -rf ${HOME}/Work/qemu-arm-xpack.git; \
 git clone \
   --branch xpack-develop \
   https://github.com/xpack-dev-tools/qemu-arm-xpack.git \
-  ~/Downloads/qemu-arm-xpack.git; \
-git -C ~/Downloads/qemu-arm-xpack.git submodule update --init --recursive
+  ${HOME}/Work/qemu-arm-xpack.git; \
+git -C ${HOME}/Work/qemu-arm-xpack.git submodule update --init --recursive
 ```
 
 For more details please read the `README-BUILD.md` file.
@@ -205,13 +205,13 @@ To build a binary which is suitable for debug sessions, run the
 ```sh
 rm -rf ~/Work/qemu-arm-dev
 
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build-native.sh --debug --develop
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build-native.sh --debug --develop
 ```
 
 To build the Windows binaries, use:
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build-native.sh --debug --develop --win
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build-native.sh --debug --develop --win
 ```
 
 The result is the `${HOME}/Work/qemu-arm-dev/${platform}-${arch}` folder. The build
@@ -249,27 +249,27 @@ in preparation for a new build.
 The operation can also be performed manually:
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build-native.sh clean
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build-native.sh clean
 ```
 
 To remove the library folders, use:
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build-native.sh cleanlibs
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build-native.sh cleanlibs
 ```
 
 To remove all:
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build-native.sh cleanall
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build-native.sh cleanall
 ```
 
 To clean the Windows build, the commands are similar:
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build-native.sh --win clean
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build-native.sh --win cleanlibs
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build-native.sh --win cleanall
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build-native.sh --win clean
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build-native.sh --win cleanlibs
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build-native.sh --win cleanall
 ```
 
 ### Edit & IntelliSense

diff --git a/README-RELEASE.md b/README-RELEASE.md
@@ -97,16 +97,16 @@ Similarly on the Intel Linux (`xbbli`):
 
 ```sh
 
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh --develop --linux64
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh --develop --linux64
 
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh --develop --win64
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh --develop --win64
 ```
 
 And on the Arm Linux (`xbbla`):
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh --develop --arm64
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/build.sh --develop --arm32
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh --develop --arm64
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/build.sh --develop --arm32
 ```
 
 Work on the scripts until all platforms pass the build.
@@ -151,7 +151,7 @@ To trigger the GitHub Actions build, use the xPack action:
 This is equivalent to:
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/trigger-workflow-build.sh
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/trigger-workflow-build.sh
 ```
 
 This script requires the `GITHUB_API_DISPATCH_TOKEN` to be present
@@ -182,9 +182,9 @@ To trigger the GitHub Actions tests, use the xPack actions:
 These are equivalent to:
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/tests/trigger-workflow-test-prime.sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-intel.sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-arm.sh
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/tests/trigger-workflow-test-prime.sh
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-intel.sh
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-arm.sh
 ```
 
 These scripts require the `GITHUB_API_DISPATCH_TOKEN` variable to be present
@@ -207,7 +207,7 @@ To trigger the Travis test, use the xPack action:
 This is equivalent to:
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/tests/trigger-travis-macos.sh
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/tests/trigger-travis-macos.sh
 ```
 
 This script requires the `TRAVIS_COM_TOKEN` variable to be present

diff --git a/scripts/tests/README.md b/scripts/tests/README.md
@@ -9,20 +9,20 @@ The binaries can be available from one of the pre-releases:
 The test script is part of the QEMU Arm xPack:
 
 ```sh
-rm -rf ~/Downloads/qemu-arm-xpack.git; \
+rm -rf ${HOME}/Work/qemu-arm-xpack.git; \
 git clone \
   --branch xpack-develop \
   https://github.com/xpack-dev-tools/qemu-arm-xpack.git  \
-  ~/Downloads/qemu-arm-xpack.git; \
-git -C ~/Downloads/qemu-arm-xpack.git submodule update --init --recursive
+  ${HOME}/Work/qemu-arm-xpack.git; \
+git -C ${HOME}/Work/qemu-arm-xpack.git submodule update --init --recursive
 ```
 
 ## Start a local test
 
 To check if QEMU Arm starts on the current platform, run a native test:
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/tests/native-test.sh \
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/tests/native-test.sh \
   --base-url "https://github.com/xpack-dev-tools/pre-releases/releases/download/test/"
 ```
 
@@ -41,15 +41,15 @@ The multi-platform tests run on GitHub Actions; they do not fire on
 git commits, but only via a manual POST to the GitHub API.
 
 ```sh
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/tests/trigger-workflow-test-prime.sh \
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/tests/trigger-workflow-test-prime.sh \
   --branch xpack-develop \
   --base-url "https://github.com/xpack-dev-tools/pre-releases/releases/download/test/"
 
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-intel.sh \
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-intel.sh \
   --branch xpack-develop \
   --base-url "https://github.com/xpack-dev-tools/pre-releases/releases/download/test/"
 
-bash ~/Downloads/qemu-arm-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-arm.sh \
+bash ${HOME}/Work/qemu-arm-xpack.git/scripts/helper/tests/trigger-workflow-test-docker-linux-arm.sh \
   --branch xpack-develop \
   --base-url "https://github.com/xpack-dev-tools/pre-releases/releases/download/test/"