Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jakarmy/swift-summary

A summary of Apple's Swift language written on Playgrounds
https://github.com/jakarmy/swift-summary

apple apple-documentation playground playgrounds playgrounds-platform swift swift-language swift-summary xcode

Last synced: 20 days ago
JSON representation

A summary of Apple's Swift language written on Playgrounds

Awesome Lists containing this project

README 

        

   ![Platform](https://img.shields.io/badge/platform-osx-lightgrey.svg)

   ![Swift](https://img.shields.io/badge/swift-v3.0-orange.svg) ![Software](https://img.shields.io/badge/software-Xcode%20%7C%20Playgrounds-blue.svg)

# The Swift Summary Book

A summary of Apple's Swift language written on Playgrounds.



### Why this summary?

Apple's documentation is great for learning Swift, but who's got the time to read all that? :smile:



This summary cuts to the chase. It is directly written on the Playgrounds platform, which makes it very interactive.

You can tinker around with it as much as you like!



## Inside the Box

Once you've downloaded or cloned the repository and you open it with Xcode, you'll find most of the chapters from Apple's documentation, plus a *Resources* folder that contains extra material. The numbering in each chapter is consistent with Apple's. Chapters with a ~~strikethrough~~ have not been added to the book yet as being considered *unimportant*. More specifically, you'll find:



**Chapters**



 01. The Basics

 02. Basic Operators

 03. ~~Strings and Characters~~

 04. Collection Types

 05. Control Flow

 06. Functions

 07. Closures

 08. Enumerations

 09. Classes & Structs

 10. Properties

 11. Methods

 12. Subscripts

 13. Inheritance

 14. Initialization

 15. Deinitialization

 16. ARC

 17. Optional Chaining

 18. Error Handling

 19. Type Casting

 20. ~~Nested Types~~

 21. Extensions

 22. Protocols

 23. Generics

 24. Access Control



**Resources**

- Higher Order Functions



## How should I install this?

Getting started with The Swift Summary Book is a piece of 🎂:



1. Just clone or download the repository.

2. You need to have Xcode v8.0 or above. You can download it [here](https://developer.apple.com/xcode/).

3. Open the `.swift` file with Xcode and *voilà*!



## What are the features?

The Swift Summary Book takes advantage of the Playground platform and many of its powerful capabilities:

* The book is made of a single file that contains all chapters inside, which allows for easy access.

* Chapters use the Playground Markup Language, which brings rich documentation to the code examples.

* Every chapter has Page Linking, which allows to go back and forth from one chapter to the next, previous or another that was mentioned with in the chapter.



## Keep in mind

The Swift language is still under rapid development, which means that the documentation is changing all the time, and some sections might break at a given time.



## You can help too!

* Help me keep this summary :+1: by creating pull requests and issues!

* Share this project and make sure you and others give it a ⭐



## You can find me on

* 🐦 twitter: [@jkarmy](http://twitter.com/jkarmy).

* ☕️ If you like the open-source work I do, consider [buying me a coffee](https://www.buymeacoffee.com/juankarmy) so I can stay awake and keep typing away!



## License

The MIT License (MIT)



Copyright (c) 2016 Juan Antonio Karmy



Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.