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

Commit f2e3185

Browse files
committed
Add Known Issues section to README
1 parent 76175f5 commit f2e3185

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,21 @@ Follow these steps to release a new version of `swift-doc`:
359359
- [x] Create a new [release](https://github.com/SwiftDocOrg/swift-doc/releases)
360360
that corresponds to the new tag.
361361

362+
## Known Issues
363+
364+
- Xcode cannot run unit tests (<kbd>⌘</kbd><kbd>U</kbd>)
365+
when opening the swift-doc package directly,
366+
as opposed first to generating an Xcode project file with
367+
`swift package generate-xcodeproj`.
368+
(The reported error is:
369+
`Library not loaded: @rpath/lib_InternalSwiftSyntaxParser.dylib`).
370+
As a workaround,
371+
you can [install the latest toolchain](https://swift.org/download/)
372+
and enable it in "Xcode > Preferences > Components > Toolchains".
373+
Alternatively,
374+
you can run unit tests from the command line
375+
with `swift test`.
376+
362377
## License
363378

364379
MIT

0 commit comments

Comments
 (0)