Skip to content

Commit 0809a71

Browse files
committed
Update README
1 parent 838b0ab commit 0809a71

File tree

1 file changed

+24
-81
lines changed

1 file changed

+24
-81
lines changed

README.md

Lines changed: 24 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -150,34 +150,41 @@ $ swiftbox upgrade
150150
Successfully upgraded swiftbox from 0.12 to 0.12.2
151151
```
152152

153+
> `swiftbox` doesn't have a stable upgrading interface until 0.12.2. Users running `swiftbox` 0.12.1 and earlier are recommended to do a fresh installation to receive latest updates:
154+
>
155+
> ```console
156+
> $ sudo curl -o /usr/bin/swiftbox https://cdn.jsdelivr.net/gh/stevapple/[email protected]/swiftbox.sh
157+
> $ sudo chmod +x /usr/bin/swiftbox
158+
> $ swiftbox upgrade
159+
> ```
160+
153161
### Show help page
154162
155163
```console
156164
$ swiftbox -h
157165
```
158166
159167
And you'll see an output as follow:
168+
160169
```
161170
swiftbox: Use Swift out of the Box on Ubuntu, CentOS(RHEL) and Amazon Linux
162-
163171
Usage: swiftbox [option]
164172
swiftbox [command] ...
165-
166173
Options:
167-
-v Show swiftbox version
168-
-h Show help page
169-
174+
-v, --version Show swiftbox and system (alias) version
175+
-s, --short Show only swiftbox version
176+
-h, --help Show help page
170177
Commands:
171-
check <version> Check the availability of Swift <version>
172-
nightly Check the availability of Swift nightly builds
173-
get <version> Get Swift <version> from swift.org
174-
nightly Get the latest nightly build from swift.org
175-
list List Swift versions on the computer
176-
use <version> Select Swift <version> as default
177-
remove <version> Remove swift <version> from the computer
178-
close Disable Swift managed by swiftbox
179-
cleanup Clear swiftbox download cache
180-
upgrade Upgrade swiftbox to the latest version
178+
check <version> Check the availability of Swift <version>
179+
nightly Check the availability of Swift nightly builds
180+
get <version> Get Swift <version> from swift.org
181+
nightly Get the latest nightly build from swift.org
182+
list List Swift versions on the computer
183+
use <version> Select Swift <version> as default
184+
remove <version> Remove swift <version> from the computer
185+
close Disable Swift managed by swiftbox
186+
cleanup Clear swiftbox download cache
187+
upgrade Upgrade swiftbox to the latest version
181188
```
182189

183190
## Advanced Usage
@@ -186,7 +193,7 @@ Commands:
186193

187194
Since Ubuntu has non-LTS versions and they may be (partially) compatible with toolchains built for LTS versions, `swiftbox` provides built-in system version alias support from version 0.12.3 (see [#1](https://github.com/stevapple/swiftbox/pull/1)).
188195

189-
`swiftbox` allows long-term alias by specifying the version in `.system-alias` file in its working directory. The aliased version will be displayed in `swiftbox -v` output.
196+
`swiftbox` allows permanent alias by specifying the version in `.system-alias` file in its working directory. The aliased version will be displayed in `swiftbox -v` output.
190197

191198
```console
192199
$ echo "20.04" > ~/.swiftbox/.system-alias
@@ -197,73 +204,9 @@ Swift 5.2.4 is available for Ubuntu 20.04
197204
You can get it with: swiftbox get 5.2.4
198205
```
199206

200-
For one-time alias, use environmental variable `$SWIFTBOX_SYSALIAS` instead:
207+
For temporary alias, use environmental variable `$SWIFTBOX_SYSALIAS` instead:
201208

202209
```console
203210
$ export SWIFTBOX_SYSALIAS="20.04"
204211
$ swiftbox get 5.2.4
205212
```
206-
207-
## Known Issues of Upgrading
208-
209-
### Version < 0.11
210-
211-
Users of these versions should do a fresh installation for the upgrade.
212-
213-
You can use one of the following ways:
214-
215-
```console
216-
$ swiftbox update
217-
swiftbox 0.9 is already installed in /usr/bin
218-
Input 'yes' or 'y' to upgrade, anything else to do a fresh installation: n
219-
```
220-
221-
```console
222-
$ sudo rm /usr/bin/swiftbox
223-
$ sh -c "$(curl -fsSL https://raw.githubusercontent.com/stevapple/swiftbox/master/install.sh)"
224-
```
225-
226-
```console
227-
$ sudo curl -o /usr/bin/swiftbox https://cdn.jsdelivr.net/gh/stevapple/[email protected]/swiftbox.sh
228-
$ sudo chmod +x /usr/bin/swiftbox
229-
$ swiftbox upgrade
230-
```
231-
232-
### Version = 0.11 | 0.11.1
233-
234-
Users of these versions should do a fresh installation for the upgrade.
235-
236-
You can use one of the following ways:
237-
238-
```console
239-
$ swiftbox upgrade
240-
swiftbox 0.11.1 is already installed in /usr/bin
241-
Input 'yes' or 'y' to upgrade, anything else to do a fresh installation: n
242-
```
243-
244-
```console
245-
$ sudo rm /usr/bin/swiftbox
246-
$ sh -c "$(curl -fsSL https://raw.githubusercontent.com/stevapple/swiftbox/master/install.sh)"
247-
```
248-
249-
```console
250-
$ sudo curl -o /usr/bin/swiftbox https://cdn.jsdelivr.net/gh/stevapple/[email protected]/swiftbox.sh
251-
$ sudo chmod +x /usr/bin/swiftbox
252-
$ swiftbox upgrade
253-
```
254-
255-
### Version = 0.12 | 0.12.1
256-
257-
Users of these versions should upgrade manually or with `sudo` if the installation path belongs to `root`.
258-
259-
You can use one of the following ways:
260-
261-
```console
262-
$ sudo swiftbox upgrade
263-
```
264-
265-
```console
266-
$ sudo curl -o /usr/bin/swiftbox https://cdn.jsdelivr.net/gh/stevapple/[email protected]/swiftbox.sh
267-
$ sudo chmod +x /usr/bin/swiftbox
268-
$ swiftbox upgrade
269-
```

0 commit comments

Comments
 (0)