File tree Expand file tree Collapse file tree 2 files changed +9
-5
lines changed Expand file tree Collapse file tree 2 files changed +9
-5
lines changed Original file line number Diff line number Diff line change @@ -35,10 +35,10 @@ and `golang/mock`.
35
35
## Installation
36
36
37
37
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.
42
42
43
43
### Dependencies
44
44
@@ -52,7 +52,8 @@ The following tools are needed to use `shellmock`:
52
52
- ` mktemp `
53
53
- ` rm `
54
54
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:
56
57
57
58
``` bash
58
59
sudo apt install -yqq bash coreutils
Original file line number Diff line number Diff line change 18
18
19
19
# Quickstart Guide
20
20
21
+ First up, if we haven't already done so, we follow [ these steps] [ installation ]
22
+ to download and install ` shellmock ` .
21
23
Now that we have downloaded ` shellmock ` to the root directory of our repository
22
24
and installed [ bats-core] on our system, we can create a simple test.
23
25
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].
105
107
[ bats-core ] : https://bats-core.readthedocs.io/ " bats core website "
106
108
[ full command reference ] : ./usage.md
107
109
[ how-to for creating tests ] : ./howto.md
110
+ [ installation ] : ../#installation
108
111
[ shellmock-tests ] : ../tests/main.bats " shellmock tests "
109
112
[ this detailed example ] : ./example.md
You can’t perform that action at this time.
0 commit comments