Add a Troubleshooting section to the README

SwiftDocOrg / swift-doc

A documentation generator for Swift projects

https://swiftdoc.org

MIT License

1.68k stars 99 forks source link

Add a Troubleshooting section to the README #286

Closed AngeloStavrow closed 3 years ago

AngeloStavrow commented 3 years ago

Closes #283.

This PR adds a first entry to a new troubleshooting section in the README, addressing #211. Please let me know if you'd prefer a different format or language, and I'll adapt this!

mattt commented 3 years ago

Thanks so much for opening this PR, @AngeloStavrow! I did some copy-editing and moved the discussion to be closer to the Homebrew installation instructions with https://github.com/SwiftDocOrg/swift-doc/pull/286/commits/eded27740c709e815ebe299414bc0990ce30d641. I'm really glad to have this information in the README, to help anyone else who hits the same issue.