From d62e261e9c27e821e5c06f2f5b5e6b7258db51fa Mon Sep 17 00:00:00 2001 From: rzmk Date: Wed, 29 May 2024 17:36:34 -0400 Subject: [PATCH] chore: add skip button for install section and refactor --- appendix.md | 16 ++++------------ exercises-setup.md | 8 ++++---- 2 files changed, 8 insertions(+), 16 deletions(-) diff --git a/appendix.md b/appendix.md index 29a0d5b..8a35996 100644 --- a/appendix.md +++ b/appendix.md @@ -4,9 +4,9 @@ jupytext: extension: .md format_name: myst kernelspec: - display_name: Python 3 - language: python - name: python3 + display_name: Bash + language: bash + name: bash --- # Appendix @@ -17,18 +17,10 @@ Here you may find conceptual content related to the exercises in the book. qsv has multiple versions and may differ for each system. Here we run [a command](https://github.com/jqnatividad/qsv/blob/master/docs/PERFORMANCE.md#version-details) to show what version of qsv this book is using along with other information: -```bash +```{code-cell} qsv --version ``` -```{code-cell} python3 -:tags: [remove-input, scroll-output] - -result = !qsv --version -print(result.n) - -``` - ## qsv release assets A mapping of qsv release files for an arbitrary version X.Y.Z and platforms they may run on are shown in the table below. diff --git a/exercises-setup.md b/exercises-setup.md index 121bdf7..79d0794 100644 --- a/exercises-setup.md +++ b/exercises-setup.md @@ -6,7 +6,7 @@ Each exercise should have a launch button for launching an online Jupyter lab en ![Binder](https://mybinder.org/badge_logo.svg) -However, you may choose to run the exercises on your system. The rest of this page is an overview of how to load the exercises and how to install qsv locally. +However, you may choose to run the exercises on your system. The rest of this page is an overview of how to load the exercises and how to install qsv locally. You may [continue to the next page](notes.md) instead if you won't do exercises on your system. ### 1. Download and extract the exercises @@ -43,9 +43,9 @@ If you have a `.zip` file downloaded then make sure to unzip it and locate the ` #### Add qsv to your PATH -To ensure you may access qsv from your terminal without having to specify a path, you'll need to add qsv to your PATH. +To ensure you may access qsv from your terminal in any directory without having to specify a path to the qsv binary file, you'll need to add qsv to your PATH environment variable. -If you used the `qsv-X.Y.Z.msi` installer for Windows then this should already have been done for you. You may verify this works by opening a terminal (Windows Terminal, Command Prompt, Git Bash, Powershell, etc.) and run `qsv`. This should output the list of available commands as intended. +If you used the `qsv-X.Y.Z.msi` installer for Windows then this should have already been done for you. You may verify this works by opening a terminal (Windows Terminal, Command Prompt, Git Bash, Powershell, etc.), type `qsv --list`, and press enter to run the command. This should output the list of available qsv commands as intended. For macOS and Linux there are various ways to add qsv to the PATH. One way is moving the `qsv` binary file to `/usr/local/bin`, which you may do by changing your directory to where `qsv` is located and running: @@ -61,7 +61,7 @@ Bash completions allow you to press the tab key at certain locations while typin ![qsv bash completions example](media/qsv-completions-demo.gif) -You can download the current bash completions file from qsv's source code at [`contrib/bashly/completions.bash`](https://github.com/jqnatividad/qsv/blob/master/contrib/bashly/completions.bash). Then you may run `source completions.bash` to enable the completions in your current terminal instance, and you may also move it to your home directory (`~/completions.bash`) and create a `.bashrc` file in your home directory (`~/.bashrc`) to include `source completions.bash` as a line within it for the completions script to run when you launch a bash terminal. +You can download the current bash completions file from qsv's source code at [`contrib/bashly/completions.bash`](https://github.com/jqnatividad/qsv/blob/master/contrib/bashly/completions.bash). Then you may run `source completions.bash` to enable the completions in your current terminal instance. You may also move `completions.bash` to your home directory (`~/completions.bash`) and also create a `.bashrc` file in your home directory (`~/.bashrc`) to include `source completions.bash` as a line within it for the completions script to run whenever you launch a bash terminal. ## Recap