From b334a0ca02355f435c5d7d39e0315b06d26700e0 Mon Sep 17 00:00:00 2001 From: Angelo Stavrow Date: Thu, 20 May 2021 06:11:03 -0400 Subject: [PATCH 1/2] Add a Troubleshooting section to the README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 8d7899a2..80148aa5 100644 --- a/README.md +++ b/README.md @@ -235,6 +235,27 @@ Here's an excerpt of the graph generated for Alamofire: ![Excerpt of swift-doc-api Diagram for Alamofire](https://user-images.githubusercontent.com/7659/73189318-0db0e880-40d9-11ea-8895-341a75ce873c.png) +## Troubleshooting + +Having trouble with SwiftDoc? Have a look at this section for help. + +### Homebrew: Failed to download resource "swift-doc" + +If using Homebrew to install or upgrade SwiftDoc fails with a `404` error similar to this: + +```bash +curl: (22) The requested URL returned error: 404 +Error: Failed to download resource "swift-doc" +``` + +Try untapping and reinstalling SwiftDoc: + +```bash +$ brew uninstall swift-doc +$ brew untap swiftdocorg/formulae +$ brew install swiftdocorg/formulae/swift-doc +``` + ## GitHub Action This repository also hosts a [GitHub Action][github actions] From eded27740c709e815ebe299414bc0990ce30d641 Mon Sep 17 00:00:00 2001 From: Mattt Date: Tue, 1 Jun 2021 04:59:33 -0700 Subject: [PATCH 2/2] Update README.md Move troubleshooting to installation section --- README.md | 40 ++++++++++++++++++---------------------- 1 file changed, 18 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 80148aa5..415c03e3 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -235,27 +252,6 @@ Here's an excerpt of the graph generated for Alamofire: ![Excerpt of swift-doc-api Diagram for Alamofire](https://user-images.githubusercontent.com/7659/73189318-0db0e880-40d9-11ea-8895-341a75ce873c.png) -## Troubleshooting - -Having trouble with SwiftDoc? Have a look at this section for help. - -### Homebrew: Failed to download resource "swift-doc" - -If using Homebrew to install or upgrade SwiftDoc fails with a `404` error similar to this: - -```bash -curl: (22) The requested URL returned error: 404 -Error: Failed to download resource "swift-doc" -``` - -Try untapping and reinstalling SwiftDoc: - -```bash -$ brew uninstall swift-doc -$ brew untap swiftdocorg/formulae -$ brew install swiftdocorg/formulae/swift-doc -``` - ## GitHub Action This repository also hosts a [GitHub Action][github actions]