dnrops
/
writefreely-swift
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README for generating documentation

This commit is contained in:
Angelo Stavrow 2021-05-20 16:01:44 -04:00
parent 13ed82b066
commit e1dfba102a
No known key found for this signature in database
GPG Key ID: 1A49C7064E060EEE
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -13,8 +13,8 @@ You'll need Xcode 11.5 / Swift 5.2 installed along with the command line tools t
Additionally, documentation is generated by [SwiftDoc](https://github.com/SwiftDocOrg/swift-doc). After making any changes to the package's public API, you'll need to regenerate the docs; to do so, run the following commands in the terminal from the root directory of the package: Additionally, documentation is generated by [SwiftDoc](https://github.com/SwiftDocOrg/swift-doc). After making any changes to the package's public API, you'll need to regenerate the docs; to do so, run the following commands in the terminal from the root directory of the package:
```bash ```bash
$ rm -rf docs/ $ rm -rf .build/documentation
$ swift doc generate Sources --module-name WriteFreely --output docs $ swift doc generate Sources --module-name WriteFreely
``` ```
### Installing ### Installing