Merge pull request #260 from gwynne/minor-readme-updates

Minor README fixes and whitespace normalization

Author: shahmishal

README.md

@@ -24,7 +24,11 @@ docker run -it swift /bin/bash
 If you want to run the Swift REPL you will need to run the container with additional privileges:
 
 ```bash
+# If running Docker on Linux:
 docker run --security-opt seccomp=unconfined -it swift
+
+# If running Docker on macOS:
+docker run --privileged -it swift
 ```
 
 We also provide a "slim" image. Slim images are images designed just for running an already built Swift program. Consequently, they do not contain the Swift compiler.
@@ -40,7 +44,7 @@ RUN swift build -c release
 FROM swift:slim
 WORKDIR /root
 COPY --from=builder /root .
-CMD [".build/x86_64-unknown-linux/release/docker-test"]
+CMD [".build/release/docker-test"]
 ```
 
 ## Contributions

swift-ci/README.md

@@ -2,22 +2,17 @@
 
 Swift.org uses Docker based virtual build environment to build & qualify Swift toolchains on Linux.
 
-The Continuous Integration system uses the Dockerfiles in this directory to define the virtual build environment,
-then runs the build and qualification steps inside a docker container based on the image.
+The Continuous Integration system uses the Dockerfiles in this directory to define the virtual build environment, then runs the build and qualification steps inside a docker container based on the image.
 
 ## Directory Structure
 
-The Dockerfiles used for Continuous Integration are layed out under the top level `swift-ci` directory.
-Under that, we have a directory for each of the target branches, e.g.
-Continuous Integration for Swift's `master` branch uses the `swift-ci/master` Dockerfiles.
+The Dockerfiles used for Continuous Integration are layed out under the top level `swift-ci` directory. Under that, we have a directory for each of the target branches, e.g. Continuous Integration for Swift's `main` branch uses the `swift-ci/master` Dockerfiles.
 
 There is also a specific directory (`swift-docc-render`) for the Dockerfile used to build Swift-DocC-Render. Swift-DocC-Render builds separately from the rest of the projects in the Swift toolchain and ships a pre-built copy for use in the toolchain in the Swift-DocC-Render-Artifact repository.
 
 ## Continuous Integration
 
-This system is designed to support many distributions.
-Once a working Dockerfile is added to this repository,
-we set up Continuous Integration jobs to produce toolchains for the distribution and publish them on Swift.org.
+This system is designed to support many distributions. Once a working Dockerfile is added to this repository, we set up Continuous Integration jobs to produce toolchains for the distribution and publish them on Swift.org.
 
 ## Local development & testing
 
@@ -27,7 +22,7 @@ First build & tag the Dockerfile:
 docker build -f <dockerfile path> . -t <some tag>
 ```
 
-Next run the Swift build using that Docker image
+Next, run the Swift build using that Docker image:
 
 ```bash
 docker run \
@@ -37,7 +32,7 @@ docker run \
   -v <some docker volume name>:/home/build-user \
   -w /home/build-user/ \
   <docker image tag from above> \
-  /bin/bash -lc "cp -r /source/* /home/build-user/; ./swift/utils/build-script --preset buildbot_linux"
+  /bin/bash -lc "cp -r /source/* /home/build-user/; ./swift/utils/build-script --preset buildbot_linux install_destdir=/home/build-user/swift-install installable_package=/home/build-user/swift-DEVELOPMENT-SNAPSHOT-$(date +'%F')-a.tar.gz"
 ```
 
 ## Contributions

swift-ci/master/debian/10/Dockerfile

@@ -30,7 +30,7 @@ RUN apt-get -y update && apt-get -y --no-install-recommends install \
   systemtap-sdt-dev     \
   tzdata                \
   unzip                 \
-  uuid-dev		\
+  uuid-dev              \
   ca-certificates
 
 USER build-user

swift-ci/master/debian/9/Dockerfile

@@ -28,9 +28,9 @@ RUN apt-get --no-install-recommends -y install \
   systemtap-sdt-dev     \
   tzdata                \
   unzip                 \
-  ca-certificates	\
+  ca-certificates       \
   uuid-dev
 
 USER build-user
 
-WORKDIR /home/build-user
+WORKDIR /home/build-user