From 5aa7ce3817fa86f9f5e4dd1346976e1effea3b7c Mon Sep 17 00:00:00 2001 From: ApolloZhu Date: Sun, 2 Apr 2017 19:58:49 -0400 Subject: [PATCH] readme --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c7fa85b..57115a2 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ > Tell us about the features and technologies you used in your Swift playground. -"Swifty Karel" is inspired by the Karel robot form Stanford University. It uses UIKit to layout and perform animations. CoreGraphics framework to perform drawings and animations, AVFoundation to play sound effects. +"Swifty Karel" is inspired by the Karel robot form Stanford University. By giving Karel commands through global functions, it can explore the "world". It is very similar to the lectures provided within Swift Playgrounds on iPad, but in 2D. + +The project is highly customizable. The Playground class is implemented as a Singleton, and it contains + +Depending on whether or not animation is on Karel itself, UIView animation will be preformed, or a scheduled timer will fire after certain delay. The project is playing background music through AVFoudation, handled by an lazily initialized player. Technically, this project used a lot of language features of Swift. Using weak references in escaping trailing closures to avoid ARC issue. By encapsulating common operations and functional programming, the code is organized. -Also, to make the playground itself appealing, Playground/Xcode markup language is used to as guide to users. By conforming to CustomPlaygroundQuicklookable, even an abstract model can be elegantly shown to the user. +By conforming to CustomPlaygroundQuicklookable, even an abstract model can be elegantly shown to the user. + +Also, to make the playground itself appealing, Playground/Xcode markup language is used to as guide to users. -Due to the known bug with Xcode playground, UIKit animation is having weird behavior, such as animate before the scheduled time, as illustrated in https://cloud.githubusercontent.com/assets/10842684/24583831/f95d2a36-1725-11e7-9430-8e35bc53173f.png