Skip to content

Commit

Permalink
Merge pull request #32 from Senzing/issue-17.dockter.7
Browse files Browse the repository at this point in the history
issue-17 Add Legend
  • Loading branch information
docktermj authored Nov 18, 2019
2 parents 22bad4b + 6241b32 commit 867f45a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ docker-rmi-for-build-development-cache:
-docker rmi --force $(DOCKER_IMAGE_TAG)

.PHONY: clean
clean: docker-rmi-for-build docker-rmi-for-build-base
clean: docker-rmi-for-build docker-rmi-for-build-development-cache

# -----------------------------------------------------------------------------
# Help
Expand Down
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,14 @@ See [best practices](docs/best-practices.md).
1. [Errors](#errors)
1. [References](#references)

### Legend

1. :thinking: - A "thinker" icon means that a little extra thinking may be required.
Perhaps you'll need to make some choices.
Perhaps it's an optional step.
1. :pencil2: - A "pencil" icon means that the instructions may need modification before performing.
1. :warning: - A "warning" icon means that something tricky is happening, so pay attention.

## Expectations

### Space
Expand Down Expand Up @@ -164,6 +172,7 @@ Use if a different userid (UID) is required.
### External database

:thinking: **Optional:** Use if storing data in an external database.
If not specified, the internal SQLite database will be used.

1. :pencil2: Specify database.
Example:
Expand All @@ -188,7 +197,7 @@ Use if a different userid (UID) is required.
Example:

```console
export SENZING_DATABASE_URL_PARAMETER="--env SENZING_DATABASE_URL=${SENZING_DATABASE_URL}
export SENZING_DATABASE_URL_PARAMETER="--env SENZING_DATABASE_URL=${SENZING_DATABASE_URL}"
```

### Database support
Expand Down

0 comments on commit 867f45a

Please sign in to comment.