Skip to content

Commit 4fe9969

Browse files
committed
Improve documentation of installation steps
Signed-off-by: Torsten Long <[email protected]>
1 parent 61b8182 commit 4fe9969

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ and `golang/mock`.
3535
## Installation
3636

3737
To get started, just head over to the [releases] and download the
38-
[latest release][latest-release].
39-
Then, you can write your [bats-core]-based tests.
40-
Just make sure to use `load shellmock` in your `setup` function.
41-
See [below](#documentation-overview) for `shellmock`'s documentation.
38+
[latest release][latest-release] to the root directory of your repository.
39+
We recommend to add the downloaded file `shellmock.bash` to your `.gitignore`.
40+
Please see [below](#documentation-overview) for `shellmock`'s detailed
41+
documentation.
4242

4343
### Dependencies
4444

@@ -52,7 +52,8 @@ The following tools are needed to use `shellmock`:
5252
- `mktemp`
5353
- `rm`
5454

55-
On Debian-based systems, they can be installed via:
55+
On Debian-based systems, if they are not already pre-installed, they can be
56+
installed via:
5657

5758
```bash
5859
sudo apt install -yqq bash coreutils

docs/quickstart.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818

1919
# Quickstart Guide
2020

21+
First up, if we haven't already done so, we follow [these steps][installation]
22+
to download and install `shellmock`.
2123
Now that we have downloaded `shellmock` to the root directory of our repository
2224
and installed [bats-core] on our system, we can create a simple test.
2325
We put the following in a file called `test.bats`:
@@ -105,5 +107,6 @@ You may also check out our [how-to for creating tests].
105107
[bats-core]: https://bats-core.readthedocs.io/ "bats core website"
106108
[full command reference]: ./usage.md
107109
[how-to for creating tests]: ./howto.md
110+
[installation]: ../#installation
108111
[shellmock-tests]: ../tests/main.bats "shellmock tests"
109112
[this detailed example]: ./example.md

0 commit comments

Comments
 (0)