From 06a3b0c188817dde6952e51c6421bf761b6e4cc6 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 7 Sep 2023 19:47:51 +0000 Subject: [PATCH] markdown source builds Auto-generated via {sandpaper} Source : 78988b274cd8bd83a5711cbf9f05603309892152 Branch : main Author : Kaitlin Newson Time : 2023-09-07 19:45:39 +0000 Message : Merge pull request #243 from LibraryCarpentry/kaitlinnewson-patch-1 Update setup.md --- index.md | 15 +++++++-------- md5sum.txt | 4 ++-- setup.md | 45 +++++++++++++++++---------------------------- 3 files changed, 26 insertions(+), 38 deletions(-) diff --git a/index.md b/index.md index 07100221..5ab6fcda 100644 --- a/index.md +++ b/index.md @@ -3,18 +3,17 @@ site: sandpaper::sandpaper_site --- This Library Carpentry lesson introduces librarians to the Unix Shell. -At the conclusion of the lesson you will: describe the basics of the Unix shell; -explain why and how to use the command line; -use shell commands to work with directories and files; -use shell commands to find and manipulate data. +At the conclusion of the lesson you will be able to: + +- describe the basics of the Unix shell; +- explain why and how to use the command line; +- use shell commands to work with directories and files; +- use shell commands to find and manipulate data. :::::::::::::::::::::::::::::::::::::::::: prereq ## Prerequisites -To complete this lesson, you will need a Unix-like shell environment -see [Setup](learners/setup.md). You will also need to download the file **[shell-lesson.zip](https://raw.githubusercontent.com/librarycarpentry/lc-shell/gh-pages/data/shell-lesson.zip)** from GitHub to your *desktop* and extract it there (once you have unzipped/extracted the file, you should end up with a folder called "shell-lesson"). - +To complete this lesson, you will need a Unix-like shell environment (see [Setup](learners/setup.md)). You will also need to download the file **[shell-lesson.zip](https://raw.githubusercontent.com/librarycarpentry/lc-shell/gh-pages/data/shell-lesson.zip)** from GitHub to your *desktop* and extract it there (once you have unzipped/extracted the file, you should end up with a folder called "shell-lesson"). :::::::::::::::::::::::::::::::::::::::::::::::::: - - diff --git a/md5sum.txt b/md5sum.txt index b1b24641..844ce4f6 100644 --- a/md5sum.txt +++ b/md5sum.txt @@ -3,7 +3,7 @@ "LICENSE.md" "b24ebbb41b14ca25cf6b8216dda83e5f" "site/built/LICENSE.md" "2023-05-08" "config.yaml" "e3cc0ef466fd9ee561541bec42dcd66e" "site/built/config.yaml" "2023-05-08" "contribute.md" "bff656c223950dd9640e88b0f45d4fa2" "site/built/contribute.md" "2023-08-29" -"index.md" "55f9e751e04c45c9c7c09f3ef1a0f7de" "site/built/index.md" "2023-05-08" +"index.md" "85087a3bf006430ecfd7332472cf5174" "site/built/index.md" "2023-09-07" "episodes/01-intro-shell.md" "4248552de8d7fe3f30930e93acef8436" "site/built/01-intro-shell.md" "2023-05-08" "episodes/02-navigating-the-filesystem.md" "b8d7414c2a1677019bc514a6cde16829" "site/built/02-navigating-the-filesystem.md" "2023-09-06" "episodes/03-working-with-files-and-folders.md" "8a1e4c89ef6df8a680bf74306f63b765" "site/built/03-working-with-files-and-folders.md" "2023-05-08" @@ -13,5 +13,5 @@ "instructors/instructor-notes.md" "c5c4f2c737b897609b8081a9193f14a2" "site/built/instructor-notes.md" "2023-05-08" "learners/discuss.md" "498cf8840b7e5bb0897f7c15af83c052" "site/built/discuss.md" "2023-08-29" "learners/reference.md" "c64333e27594cec4e38d925ce94017fb" "site/built/reference.md" "2023-05-08" -"learners/setup.md" "fbeebe385d515e9f2be0c07642ae338d" "site/built/setup.md" "2023-05-08" +"learners/setup.md" "26c8be5e75d59327fb02fd3564eb834b" "site/built/setup.md" "2023-09-07" "profiles/learner-profiles.md" "60b93493cf1da06dfd63255d73854461" "site/built/learner-profiles.md" "2023-05-08" diff --git a/setup.md b/setup.md index 1d1ed30b..ad888d6c 100644 --- a/setup.md +++ b/setup.md @@ -3,38 +3,29 @@ title: Setup --- To participate in this Library Carpentry lesson, you will need a working Unix-like shell environment. -Specifically we will be using Bash ([Bourne Again Shell](https://en.wikipedia.org/wiki/Bash_\(Unix_shell\))) which is standard on Linux and macOS. macOS Catalina users will have zsh (Z shell) as their default version. -Even if you are a Windows user, learning Bash will open up a powerful set of tools on your personal machine, in addition to familiarizing you with the standard remote interface used on almost all servers and super computers. +We will be using Bash ([Bourne Again Shell](https://en.wikipedia.org/wiki/Bash_\(Unix_shell\))) which is standard on Linux and macOS. Some macOS users (Catalina or later) will have zsh (Z shell) as their default version. +Even if you are a Windows user, learning Bash will open up a powerful set of tools on your personal machine, and familiarize you with the standard remote interface used on most servers and supercomputers. :::::::::::::::::::::::::::::::::::::::::: prereq ## Terminal Setup -Bash is the default shell on most Linux distributions and macOS. +Bash is the default shell on most Linux distributions and older versions of macOS. Windows users will need to install Git Bash to provide a Unix-like environment. -- **Linux:** The default shell is usually Bash, but if your machine is set up differently you can run it by opening a terminal >and typing `bash`. There is no need to install anything. Look for Terminal in your applications to start the Bash shell. +- **Linux:** The default shell is usually Bash, but if your machine is set up differently you can run it by opening a terminal and typing `bash` followed by the enter key. There is no need to install anything. Look for Terminal in your applications to start the Bash shell. -- **macOS:** Bash is the default shell in all versions of macOS prior to Catalina, you do not need to install anything. Open Terminal from >`/Applications/Utilities` or spotlight search to start the Bash shell. zsh is the default in Catalina. +- **macOS:** Open Terminal from `/Applications/Utilities` or Spotlight Search. In versions before Catalina, Bash is the default shell, so you do not need to do anything further. In Catalina and onwards, the default shell is zsh, which is similar but may behave differently from Bash in some cases. To switch to Bash, enter the command `bash` in your terminal window followed by the enter key. - **Windows:** On Windows, CMD or PowerShell are normally available as the default shell environments. These use a syntax and set of applications unique to Windows systems and are incompatible with the more widely used Unix utilities. However, a Bash shell can be installed on Windows to provide a Unix-like environment. For this lesson we suggest using Git Bash, part of the >[Git for Windows](https://gitforwindows.org/) package: - Download the latest Git for Windows [installer](https://gitforwindows.org/). - - Double click the `.exe` to run the installer (for example, `Git-2.13.3-64-bit.exe`) using the default settings. + - Double click the `.exe` file to run the installer (for example, `Git-2.42.0.2-64-bit.exe`) using the default settings. - Once installed, open the shell by selecting Git Bash from the start menu (in the Git folder). - - There are also some more advanced solutions available for running Bash - commands on Windows. A Bash shell command-line tool is available for - Windows 10, which you can use if you enable the [Windows Subsystem for - Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10). - Additionally, you can run Bash commands on a remote computer or server - that already has a Unix Shell, from your Windows machine. This can - usually be done through a Secure Shell (SSH) client. One such client - available for free for Windows computers is - [PuTTY](https://www.putty.org/). -If you encounter issues, the Carpentries maintains a [Configuration Problems and Solutions wiki page](https://github.com/carpentries/workshop-template/wiki/Configuration-Problems-and-Solutions) that may help. + There are also some more advanced solutions available for running Bash commands on Windows. A Bash shell command-line tool is available for Windows 10, which you can use if you enable the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10). You can also run Bash commands on a remote computer or server that already has a Unix Shell from your Windows machine. This can be done through a Secure Shell (SSH) client. One client available for free for Windows is [PuTTY](https://www.putty.org/). +If you encounter issues, the Carpentries has a [Configuration Problems and Solutions wiki page](https://github.com/carpentries/workshop-template/wiki/Configuration-Problems-and-Solutions) that may help. :::::::::::::::::::::::::::::::::::::::::::::::::: @@ -48,20 +39,18 @@ You need to download some files to follow this lesson: 2. Unzip/extract the file (ask your instructor if you need help with this step). You should end up with a new folder called `shell-lesson` on your Desktop. 3. Open the terminal and type `ls` followed by the enter key. -```bash -$ ls -``` + ```bash + $ ls + ``` -You should see a list of files and folders in your current directory. -4\. Then type: + You should see a list of files and folders in your current directory. -```bash -$ pwd -``` +4. Then type: -This command will show you where you are in your file system, which should now be your home directory. In the lesson, you will find out more about the commands `ls`, `pwd` and how to work with the data in `shell-lesson` folder. + ```bash + $ pwd + ``` + This command will show you where you are in your file system, which should now be your home directory. In the lesson, you will find out more about the commands `ls`, `pwd` and how to work with the data in `shell-lesson` folder. :::::::::::::::::::::::::::::::::::::::::::::::::: - -