Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Add a Troubleshooting section to the README #286

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,24 @@ as well as top-level type aliases, functions, and variables.

Run the following command to install using [Homebrew](https://brew.sh/):

```terminal
```console
$ brew install swiftdocorg/formulae/swift-doc
```

If you already have `swift-doc` installed,
run the following command to upgrade your installation:

```console
$ brew upgrade swift-doc
```

If installing or upgrading fails with the message
*Error: Failed to download resource "swift-doc"*,
try resetting your installation with the following commands:

```console
$ brew uninstall swift-doc
$ brew untap swiftdocorg/formulae
$ brew install swiftdocorg/formulae/swift-doc
```

Expand Down