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

Commit 131e23b

Browse files
AngeloStavrowmattt
andauthored
Add a Troubleshooting section to the README (#286)
* Add a Troubleshooting section to the README * Update README.md Move troubleshooting to installation section Co-authored-by: Mattt <mattt@me.com>
1 parent 7fbe858 commit 131e23b

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,24 @@ as well as top-level type aliases, functions, and variables.
3030

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

33-
```terminal
33+
```console
34+
$ brew install swiftdocorg/formulae/swift-doc
35+
```
36+
37+
If you already have `swift-doc` installed,
38+
run the following command to upgrade your installation:
39+
40+
```console
41+
$ brew upgrade swift-doc
42+
```
43+
44+
If installing or upgrading fails with the message
45+
*Error: Failed to download resource "swift-doc"*,
46+
try resetting your installation with the following commands:
47+
48+
```console
49+
$ brew uninstall swift-doc
50+
$ brew untap swiftdocorg/formulae
3451
$ brew install swiftdocorg/formulae/swift-doc
3552
```
3653

0 commit comments

Comments
 (0)