Skip to content

Commit b42ebc7

Browse files
committed
Adjust details in README
1 parent 25932cc commit b42ebc7

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You may be asking:
1414

1515
## Getting started
1616

17-
### Requirements
17+
### Pre-requirements
1818

1919
#### Python
2020

@@ -37,6 +37,7 @@ $ python -m venv .venv
3737
$ source .venv/bin/activate
3838
# Bundle all your dependencies into `bin/` before deploying!
3939
# Skip it if you're not building an app.
40+
# Use `splunk-sdk[compat]` if you encounter issues with `six` when deploying to Splunk.
4041
$ python -m pip install splunk-sdk --target bin/
4142
```
4243

@@ -179,9 +180,9 @@ A file called `.env.template` exists in the root of this repository. Duplicate i
179180
180181
```sh
181182
# Run entire test suite:
182-
make test
183+
$ make test
183184
# Run only the unit tests:
184-
make test-unit
185+
$ make test-unit
185186
```
186187

187188
##### Integration tests
@@ -191,10 +192,10 @@ make test-unit
191192
```sh
192193
# This command starts a Splunk Docker container
193194
# and waits until it reaches an operational state.
194-
SPLUNK_VERSION=latest make docker-start
195+
$ SPLUNK_VERSION=latest make docker-start
195196

196197
# Run the integration tests:
197-
make test-integration
198+
$ make test-integration
198199
```
199200

200201
> Do not run the test suite against a production instance of Splunk! It will run just fine with the free Splunk license.

0 commit comments

Comments
 (0)