Skip to content

Commit a9eecca

Browse files
cmcgee1024heckj
andauthored
Update the abstracts for the HowTo guides, Rename HOWTOS to Guides (#264)
Update the abstracts for the HowTo guides, Rename HOWTOS to Guides (#258) Updates the abstracts for each of the HowTo guides, and renames the topic heading from 'HOWTOS' to 'Guides'. Co-authored-by: Joseph Heck <[email protected]>
1 parent 9947c62 commit a9eecca

File tree

7 files changed

+10
-7
lines changed

7 files changed

+10
-7
lines changed

Documentation/SwiftlyDocs.docc/SwiftlyDocs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Install and manage your Swift programming language toolchains.
1010

1111
- <doc:getting-started>
1212

13-
### HOWTOS
13+
### Guides
1414

1515
- <doc:install-toolchains>
1616
- <doc:use-toolchains>

Documentation/SwiftlyDocs.docc/automated-install.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Install Swiftly Automatically
22

3-
Swiftly can be installed automatically in places like build/CI systems.
3+
Automatically install swiftly and Swift toolchains.
44

5-
This guide will help you to script to the installation of swiftly and toolchains so that it can be unattended. We assume that you have working understanding of your build system. The examples are based on a typical Unix environment.
5+
This guide helps you to automate the installation of swiftly and toolchains so that it can run unattended, for example in build or continous integration systems.
6+
We assume that you have working understanding of your build system. The examples are based on a typical Unix environment.
67

78
First, download the swiftly binary from swift.org for your operating system (e.g. Linux) and processor architecture (e.g. arm64, or x86_64). Here's an example using the popular curl command.
89

Documentation/SwiftlyDocs.docc/install-toolchains.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Install Swift Toolchains
22

3-
swiftly install
3+
Install swift toolchains with Swiftly.
44

55
Installing a swift toolchain using swiftly involves downloading it securely and extracting it into a well-known location in your account. Here we will guide you through the different ways you can install a swift toolchain. You will need to install swiftly first. The [Getting Started](getting-started.md) guide is a good place to start with swiftly.
66

Documentation/SwiftlyDocs.docc/shell-autocompletion.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Add Shell Auto-completions
22

3+
Generate shell auto-completions for Swiftly.
4+
35
Swiftly can generate shell auto-completion scripts for your shell to automatically complete subcommands, arguments, options and flags. It does this using the [swift-argument-parser](https://apple.github.io/swift-argument-parser/documentation/argumentparser/installingcompletionscripts/), which has support for Bash, Z shell, and Fish.
46

57
You can ask swiftly to generate the script using the hidden `--generate-completion-script` flag with the type of shell like this:

Documentation/SwiftlyDocs.docc/uninstall-toolchains.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Uninstall Swift Toolchains
22

3-
swiftly uninstall
3+
Uninstall Swift toolchains.
44

55
After installing several toolchains the list of the available toolchains to use becomes too large. Each toolchain also occupies substantial storage space. It's good to be able to cleanup toolchains when they aren't needed anymore. This guide will cover how to uninstall your toolchains assuming that you have installed swiftly and used it to install them.
66

Documentation/SwiftlyDocs.docc/update-toolchain.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Update Swift Toolchain
22

3-
swiftly update
3+
Update swift toolchains.
44

55
Update replaces a given toolchain with a later version of that toolchain. For a stable release, this means updating to a later patch, minor, or major version. For snapshots, this means updating to the most recently available snapshot. Swiftly can help you to keep up-to-date. We assume that you have installed swiftly and use it to manage your toolchains.
66

Documentation/SwiftlyDocs.docc/use-toolchains.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Use Swift Toolchains
22

3-
swiftly use and swiftly run
3+
Using installed swift toolchains.
44

55
Swiftly toolchains include a variety of compilers, linkers, debuggers, documentation generators, and other useful tools for working with Swift. Using a toolchain activates it so that when you run toolchain commands they are run with that version.
66

0 commit comments

Comments
 (0)