Skip to content

Commit

Permalink
feat: appendix - installing the samples (#324)
Browse files Browse the repository at this point in the history
  • Loading branch information
dwmkerr committed May 12, 2024
1 parent c14d49b commit 6d5b482
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/00-index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ For the newcomer, you'll learn what a shell is, how to use it on your system, an

If you are using a computer, you have enough to get started! In [_Chapter 1 - Setting Up Your Shell Environment_](./01-transitioning-to-the-shell/01-getting-started/index.md) you'll learn how to setup your shell in Windows, Linux or MacOS.

Run the following command in your shell to download the samples:

```bash
curl effective.sh | sh
```

No Linux, shell or programming knowledge is required to use this book, all underlying concepts will be explained as we go along. Advanced users will be able to skip some of the explanations, but there is also enough depth in each chapter that users of all levels should be able to learn something new.

## How To Read This Book
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ Rather than dissecting each and every option or flag and every nuance of the pro

:::tip Downloading the Samples


Run the following command in your shell to download the samples:

```bash
Expand Down
38 changes: 38 additions & 0 deletions docs/xx-appendices/01-installing-samples/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Installing the Samples
description: How to install the Effective Shell Samples
---

There are many samples in the Effective Shell book. To allow you to play with a set of folders and files without affecting your own personal documents, a samples folder can be installed. Each of the examples in the book uses the samples from this folder.

The easiest way to install the samples is to run the following command:

```bash
curl effective.sh | sh
```

This will install the samples to the following location:

```
~/effective-shell
```

It will also allow you to overwrite the samples, update or recreate them if you run the command multiple times.

## Manually Downloading the Samples

If you would prefer to manually download and unzip the samples, perhaps so that you can install them to a different location, you can download them as a zip file from:

- https://effective-shell.com/downloads/effective-shell-samples.zip

You can also download them as a tarball from:

- https://effective-shell.com/downloads/effective-shell-samples.tar.gz

## Deleting the Samples

If you have installed the samples to the default location, you can safely delete them with the following command:

```bash
rm -rf ~/effective-shell
```

0 comments on commit 6d5b482

Please sign in to comment.