Permalink
Browse files

document NIO 2 development in the README (#715)

Motivation:

We're at the moment devloping NIO 2 and we should tell people.

Modifications:

- changed readme
- document how to develop with the latest Xcode

Result:

- fixes #771
  • Loading branch information...
weissi committed Dec 18, 2018
1 parent 531745d commit 0beabb63bce5d9a83c0e58c24f066e35511050e6
Showing with 16 additions and 4 deletions.
  1. +16 −4 README.md
@@ -22,6 +22,10 @@ SwiftNIO aims to support all of the platforms where Swift is supported. Currentl
* Ubuntu 14.04+
* macOS 10.12+

#### Swift versions

The latest released SwiftNIO version supports Swift 4.0, 4.1, and 4.2.

### Basic Architecture

The basic building blocks of SwiftNIO are the following 8 types of objects:
@@ -203,30 +207,38 @@ First make sure you have [Docker](https://www.docker.com/community-edition) inst

## Developing SwiftNIO

*Note*: This section is only relevant if you would like to develop SwiftNIO yourself. You can ignore the information here if you just want to use SwiftNIO as a SwiftPM package.

For the most part, SwiftNIO development is as straightforward as any other SwiftPM project. With that said, we do have a few processes that are worth understanding before you contribute. For details, please see `CONTRIBUTING.md` in this repository.

### Prerequisites

SwiftNIO's `master` branch is at the moment developing what will become SwiftNIO 2.0.0 which will be Swift 5-only. That means to develop SwiftNIO at the moment, you will need:

- a recent [Swift 5.0 development snapshot](https://swift.org/download/#snapshots)
- [patch a plist file in your Xcode](https://forums.swift.org/t/how-to-set-swift-version-5-for-recent-dev-snapshots-in-xcode-build-settings/18692/20)

To be able to compile and run SwiftNIO and the integration tests, you need to
have a few prerequisites installed on your system.

#### macOS

- Xcode 9 or newer
- Xcode 10.1 or newer, with at the moment a [small patch](https://forums.swift.org/t/how-to-set-swift-version-5-for-recent-dev-snapshots-in-xcode-build-settings/18692/20) to plist file inside Xcode.

### Linux

- Swift 4.0 or newer
- Swift 5 development snapshots
- pkg-config
- zlib and its development headers
- netcat (for integration tests only)
- lsof (for integration tests only)
- shasum (for integration tests only)

#### Ubuntu
#### Ubuntu 18.04

```
# install swift tarball from https://swift.org/downloads
apt-get install -y zlib1g-dev netcat-openbsd lsof perl
apt-get install -y git curl libatomic1 libicu60 libxml2 libz-dev pkg-config clang netcat-openbsd lsof perl
```


0 comments on commit 0beabb6

Please sign in to comment.