Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
uraimo committed Mar 31, 2019
1 parent 851c30b commit bfda68b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
<p align="center" style="margin-bottom:30px;">
<img src="https://raw.githubusercontent.com/uraimo/buildSwiftOnARM/master/logo.svg?sanitize=true"/>
<i>Scripts to clone, configure, patch and build Swift 4.2.3 on Linux ARM devices.</i>
<i>Scripts to clone, configure, patch and build Swift 5.0 on Linux ARM devices.</i>
</p>

### Summary

- [Supported Architectures](#supported-architectures)
- [4.2.x Status](#status)
- [Prebuilt binaries](#prebuilt-binaries)
- [Dependencies](#dependencies)
- [Building on ARM](#building-on-arm)
Expand All @@ -22,9 +21,6 @@
* ✅ ARMv7/8 32bit: _All versions of RaspberryPi 2/3, OrangePi, ODroid, CHIP, etc..._
* ✅ aarch64: _RaspberryPis or other ARMv8 boards with a 64 bit OS, Pine64, etc..._

## Status

Currently 4.2.x still has an unfixed [issue](/~https://github.com/uraimo/buildSwiftOnARM/issues), if your use case is impacted by that bug, check out [4.1.3](/~https://github.com/uraimo/buildSwiftOnARM/tree/4.1.3).

## Prebuilt binaries

Expand Down Expand Up @@ -57,7 +53,7 @@ The scripts that buildSwiftOnARM provides:

- clone.sh - Install dependencies and clones the main Swift repository and all the related projects

- checkoutRelease.sh - Resets all repos, updates them, checks out a specific tag (4.2.3 at the moment) and apply the patches.
- checkoutRelease.sh - Resets all repos, updates them, checks out a specific tag (5.0 at the moment) and apply the patches.

- build.sh - Builds Swift producing a tgz archive with the Swift distributions.

Expand Down Expand Up @@ -91,11 +87,11 @@ Now, call the included scripts as follows:

1. Launch `clone.sh` that will install the required dependencies (_git cmake ninja-build clang-3.8 python uuid-dev libicu-dev icu-devtools libbsd-dev libedit-dev libxml2-dev libsqlite3-dev swig libpython-dev libncurses5-dev pkg-config libblocksruntime-dev libcurl4-openssl-dev autoconf libtool systemtap-sdt-dev libcurl4-openssl-dev libz-dev_), fix clang links and clone apple/swift with all its dependecies.

2. Run `checkoutRelease.sh` that will select the current release (4.2.3) and apply the needed patches. These patches cover the basic Raspi2/3 with Xenial case, but I've had many reports of successful build on different setups, but beware, additional patches could be needed on different boards/OSs.
2. Run `checkoutRelease.sh` that will select the current release (5.0) and apply the needed patches. These patches cover the basic Raspi2/3 with Xenial case, but I've had many reports of successful build on different setups, but beware, additional patches could be needed on different boards/OSs.

3. Once done, start the build with `build.sh`.

4. Once the build completes a few hours later, you'll have a `swift-4.2.3.tgz` archive containing the whole Swift compiler distribution. Once decompressed you'll find the Swift binaries under `usr/bin`.
4. Once the build completes a few hours later, you'll have a `swift-5.0.tgz` archive containing the whole Swift compiler distribution. Once decompressed you'll find the Swift binaries under `usr/bin`.

I recommend to perform all these operations in a permanent background `tmux` or `screen` session (`CTRL+B d` to detach from the session and `tmux a` to reattach to it when you ssh again into the RaspberryPi).

Expand Down Expand Up @@ -126,6 +122,7 @@ The community can be reached at the [swift-arm](https://launchpass.com/swift-arm

You can compile old releases checking out the specific tag:

* [Swift 4.2.3](/~https://github.com/uraimo/buildSwiftOnARM/tree/4.2.3)
* [Swift 4.2.2](/~https://github.com/uraimo/buildSwiftOnARM/tree/4.2.2)
* [Swift 4.2.1](/~https://github.com/uraimo/buildSwiftOnARM/tree/4.2.1)
* [Swift 4.1.3](/~https://github.com/uraimo/buildSwiftOnARM/tree/4.1.3)
Expand Down
2 changes: 1 addition & 1 deletion buildTest.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
. "$(dirname $0)/utils.sh"

REL=4.2.3
REL=5.0

INSTALL_DIR=`pwd`/install
PACKAGE=`pwd`/swift-${REL}_${ARCH}.tgz
Expand Down

0 comments on commit bfda68b

Please sign in to comment.