Skip to content

Commit 0c5324f

Browse files
committed
update README.md for style and to avoid Swift version dependencies
Do not specifically refer to Swift 5.7.1 in README.md, to avoid having to update it on every minor Swift update. Some small stylistic and syntactic changes.
1 parent dfa9ee7 commit 0c5324f

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# meta-swift
2-
Yocto meta-layer for swift-on-arm (Swift 5.7.1)
2+
3+
Yocto layer for the Swift programming language.
34

45
# Usage
56

6-
Add this meta layer to your project (refer to yocto user manual)
7+
Add this layer to your project (refer to Yocto user manual, or use `bitbake-layers add-layer`).
78

8-
Create a new swift application and include it in your yocto build as follows...
9+
Create a new Swift application and include it in your build as follows:
910

1011
```
11-
DESCRIPTION = "My swift 5.7.1 app"
12+
DESCRIPTION = "My Swift app"
1213
LICENSE = "CLOSED"
1314
1415
SRC_URI = "file://Sources/hello-world/main.swift \
@@ -18,14 +19,14 @@ SRC_URI = "file://Sources/hello-world/main.swift \
1819
inherit swift
1920
```
2021

21-
This does a few things, when you `inherit swift` meta-layer class, it will does the following...
22+
When you `inherit swift` class, it does the following:
2223

23-
- Automatically download the x86_64 and ARMv7 swift 5.7.1 binaries and create a cross-compiling sys-root
24-
- Add an RDEPENDS_${PN} for `swift` which is the Armv7 runtime
24+
- Automatically download the x86\_64 SDK binaries and create a cross-compiling sysroot
25+
- Add an RDEPENDS:${PN} for `swift`
2526
- Performs the required build steps
2627

2728
# Deployment
2829

29-
The user of this meta-layer must provide their own `do_install` function.
30+
The user of this layer must provide their own `do_install` function.
3031

31-
The finished binaries are located in ${WORKDIR}/.build/release/*
32+
The finished binaries are located in ${BUILD\_DIR}.

0 commit comments

Comments
 (0)