Skip to content

Commit b7e96df

Browse files
committed
Create preview_docs.sh and update installation instructions
1 parent d805f12 commit b7e96df

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

Documentation/SwiftBundler/SwiftBundler.docc/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Install the latest release of Swift Bundler using [mint](https://github.com/yona
1010
mint install stackotter/swift-bundler
1111
```
1212

13-
> NOTE: If you have previously installed Swift Bundler with the installation script method, remove `/opt/swift-bundler`.
13+
> NOTE: If you have previously installed Swift Bundler via the installation script you must delete the `/opt/swift-bundler` directory (requires sudo).
1414
1515
## Manual installation
1616

Documentation/generate_docs.sh

Lines changed: 0 additions & 1 deletion
This file was deleted.

Documentation/preview_docs.sh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/bin/sh
2+
swift package --disable-sandbox plugin preview-documentation --target SwiftBundler -p 8080

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ Install the latest version of Swift Bundler with [mint](https://github.com/yonas
2828
mint install stackotter/swift-bundler
2929
```
3030

31-
For more installation methods, see [the documentation](https://stackotter.github.io/swift-bundler/documentation/swiftbundler/installation).
31+
If you have previously installed Swift Bundler via the installation script you must delete the `/opt/swift-bundler` directory (requires sudo).
3232

33-
If you have previously installed Swift Bundler with the installation script method, remove `/opt/swift-bundler`.
33+
For more installation methods, see [the documentation](https://stackotter.github.io/swift-bundler/documentation/swiftbundler/installation).
3434

3535
## Getting started 🚦
3636

0 commit comments

Comments
 (0)