Merge pull request #832 from diederich/development

This is to announce the end of maintenance of three20.
facebookarchive · Jun 27, 2013 · 3587c1d · 3587c1d
2 parents cc67213 + ed72c56
commit 3587c1d
Show file tree

Hide file tree

Showing 1,248 changed files with 14 additions and 131,127 deletions.
diff --git a/README.mdown b/README.mdown
@@ -1,182 +1,25 @@
 Three20
 =======
 
-Three20 is a collection of iPhone UI classes, like a photo viewer, and general
+Support of Three20 has been discontinued.
-utilities, like an HTTP disk cache.  Three20 is derived from the
-[Facebook iPhone app][], which is one of the most downloaded iPhone apps ever.
 
-[![](http://farm4.static.flickr.com/3447/3378092101_40a62a04b2_m.jpg)](http://farm4.static.flickr.com/3447/3378092101_b064d8e339_o.jpg)
-[![](http://farm4.static.flickr.com/3432/3378117315_846547cfba_m.jpg)](http://farm4.static.flickr.com/3432/3378117315_3bf905bdb6_o.jpg) 
-[![](http://farm4.static.flickr.com/3462/3378171111_ec1208541d_m.jpg)](http://farm4.static.flickr.com/3462/3378171111_666173111d_o.jpg)
-[![](http://farm4.static.flickr.com/3646/3378998444_d0534d337f_m.jpg)](http://farm4.static.flickr.com/3646/3378998444_8d3b1eeef8_o.jpg)
-[![](http://farm4.static.flickr.com/3552/3378940896_7b23cca98e_m.jpg)](http://farm4.static.flickr.com/3552/3378940896_8ccb5ea1c8_o.jpg)
-[![](http://farm4.static.flickr.com/3382/3425636810_483f1b65a6_m.jpg)](http://farm4.static.flickr.com/3382/3425636810_b0a578bb22_o.jpg)
 
-Community
+What now?
-=========
+------
 
-If you would like to ask any questions regarding Three20, please check out any of the following:
+If you updated to this revision by accident (e.g. a git pull), you might want to switch back to the
+version you had before (`git checkout cc672132ab`). 
 
-* [Three20.info][]
+Three20 still compiles and seems to work on iOS6, so there's no immediate need to remove everything now. 
-* [Three20 Mailing List][]
+Still, as the library is not maintained anymore, it might be a good time to replace it.
-* [Three20 Tagged Questions on StackOverflow][]
 
-Documentation
+Lots of Three20's helpers are not needed anymore, as they are now present right in iOS.
-==============================
+For other parts there are some really good replacement available. 
+If you're searching for a full replacement, [NimbusKit][http://nimbuskit.info] might help, they even provide a [migration guide][http://wiki.nimbuskit.info/Three20-Migration-Guide].
 
-You can access Three20 API documentation in several ways:
+Links
+------
 
-1. Online: http://facebook.github.com/three20/api
+[Three20 Mailing List][http://groups.google.com/group/three20/]
-1. Within Xcode: 
-    1. Open your Xcode Preferences (`⌘,`) and switch to Documentation tab. 
-    1. Click the `+` button
-    1. Add the Three20 doc set feed: `feed://facebook.github.com/three20/api/com.facebook.Three20.atom`
-1. Generate the documentation from the project repository with the `src/scripts/docs.py` script
 
-Adding Three20 to your project
+[Three20 Tagged Questions on StackOverflow][http://stackoverflow.com/questions/tagged/three20]
-==============================
-
-Three20 is compiled as static libraries. It use Xcode's "dependent project" facilities.
-There are two methods of adding Three20 to your project.
-
-The first is with the [TTModule Python Script][].
-
-The Second option is to add it to your project manually.  Here is how:  
-**Estimated time:** 5 minutes.
-
-1. Clone the three20 git repository: `git clone git://github.com/facebook/three20.git`.  Make sure 
-   you store the repository in a permanent place because Xcode will need to reference the files
-   every time you compile your project.
-
-2. Locate the "Three20.xcodeproj" file under "`three20/src/Three20/`". Drag Three20.xcodeproj and
-   drop it onto the root of your Xcode project's "Groups and Files"  sidebar.  A dialog will
-   appear -- make sure "Copy items" is unchecked and "Reference Type" is "Relative to Project"
-   before clicking "Add".    
-
-3. Open the Three20 Xcode Project that you just added to your app and expand the "Dependencies"
-   group. Select all of the projects listed there and drag them to your app as well. You should
-   now have the following list of Three20 projects added to your app:
-     * Three20Core
-     * Three20Network
-     * Three20Style
-     * Three20UICommon
-     * Three20UINavigator
-     * Three20UI
-     * Three20
-
-4. Now you need to link the Three20 static libraries to your project. Select your Project Target. 
-   Under the "Build Phases" tab you will see "Link Binary With Libaries" section. Click on the 
-   "+" button, select "libThree20.a" and each of the other files, and select "Add". This will link 
-   each part of the Three20 framework to you app.
-
-5. Now you need to add Three20 as a dependency of your project, so Xcode compiles it whenever
-   you compile your project.  Expand the "Targets" section of the sidebar and double-click your
-   application's target.  Under the "General" tab you will see a "Direct Dependencies" section. 
-   Click the "+" button, select "Three20" and each of the other libs, and click "Add Target".
-   You do *not* need to add the `UnitTests` target for each lib.
-
-6. Now you need to add the bundle of images and strings to your app.  Locate "Three20.bundle" under
-   "three20/src" and drag and drop it into your project.  A dialog will appear -- make sure 
-   "Create Folder References" is selected,  "Copy items" is unchecked, and "Reference Type" is 
-   "Relative to Project" before clicking "Add".
-
-7. Now you need to add the Core Animation framework to your project.  Right click on the
-   "Frameworks" group in your project (or equivalent) and select Add > Existing Frameworks. 
-   Then locate QuartzCore.framework and add it to the project.
-
-8. Finally, we need to tell your project where to find the Three20 headers.  Open your
-   "Project Settings" and go to the "Build" tab. Look for "Header Search Paths" and double-click
-   it. Add these two "$(BUILT_PRODUCTS_DIR)/../three20" and "$(BUILT_PRODUCTS_DIR)/../../three20"
-
-9. While you are in Project Settings, go to "Other Linker Flags" under the "Linker" section, and
-   add "-ObjC" and "-all_load" to the list of flags.
-
-10. You're ready to go.  Just #import "Three20/Three20.h" anywhere you want to use Three20 classes
-   in your project.
-
-An Overview of Three20
-======================
-                  
-Photo Viewer
-------------
-
-[TTPhotoViewController][] emulates Apple's Photos app with all of its flick n' pinch delight.
-You can supply your own "photo sources", which works similiarly to the data sources used by
-UITableView.  Unlike Apple's Photos app, it isn't limited to photos stored locally.  Your
-photos can be loaded from the network, and long lists of photos can be loaded incrementally.
-
-Message composer
-----------------
-
-[TTMessageController][] emulates the message composer in Apple's Mail app.  You can customize it
-to send any kind of message you want. Include your own set of message fields, or use the
-standard "To:" and "Subject:".  Recipient names can be autocompleted from a data source that
-you provide.
-
-Web image views
------------------------
-
-[TTImageView][] makes it as easy to display an image as it is in HTML.  Just supply the URL
-of the image, and TTImageView loads it and displays it efficiently.  TTImageView also works
-with the HTTP cache described below to avoid hitting the network when possible.
-
-Internet-aware table view controllers
----------------------------------------
-
-[TTTableViewController][] and [TTTableViewDataSource][] help you to build tables which load
-their content from the Internet.  Rather than just assuming you have all the data ready to go,
-like UITableView does by default, TTTableViewController lets you communicate when your data is
-loading, and when there is an error or nothing to display.  It also helps you to add a "More"
-button to load the next page of data, and optionally supports reloading the data by shaking the
-device.
-
-Better text fields
-------------------
-
-[TTTextEditor][] is a UITextView which can grow in height automatically as you type.  I use
-this for entering messages in Facebook Chat, and it behaves similarly to the editor in Apple's
-SMS app.
-
-[TTPickerTextField][] is a type-ahead UITextField.  As you type it searches a data source, and
-it adds bubbles into the flow of text when you choose a type-ahead option.  I use this in
-TTMessageController for selecting the names of message recipients.
-
-HTTP disk cache
---------------
-
-[TTURLRequest][] is a replacement for NSURLRequest which supports a disk cache (NSURLRequest
-can only cache in RAM).  It has some other nice features too.  HTTP posts are as easy as
-supplying a dictionary of parameters.  The TTURL loading system can also be suspended and
-resumed at any time, which is a great performance helper.  Network threads often fight with
-the UI thread, so you can suspend the network any time your app is momentarily graphically
-intensive.
-
-URL-based Navigation
---------------------
-
-[TTNavigator][] is for those grizzled old web developers like myself who want to
-organize their app by "pages" which can be displayed by visiting a URL.
-
-Your view controllers can simply register URL patterns that they handle, and when those URLs
-are visited the controllers will be created and displayed.  You can also register generic
-actions that are called when a URL is visited.
-
-TTNavigator also persists and restores the full path of navigation controllers and modal
-view controllers, so your users can quit the app and come back exactly where they left off.
-
-Learn more at [Three20.info][]
-
-[Facebook iPhone app]: http://phobos.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=284882215&mt=8
-[Three20.info]: http://Three20.info
-[Three20 Mailing List]: http://groups.google.com/group/three20/
-[Three20 Tagged Questions on StackOverflow]: http://stackoverflow.com/questions/tagged/three20
-[TTPhotoViewController]: http://github.com/facebook/three20/blob/master/src/Three20UI/Headers/TTPhotoViewController.h
-[TTMessageController]: http://github.com/facebook/three20/blob/master/src/Three20UI/Headers/TTMessageController.h
-[TTImageView]: http://github.com/facebook/three20/blob/master/src/Three20UI/Headers/TTImageView.h
-[TTTableViewController]: http://github.com/facebook/three20/blob/master/src/Three20UI/Headers/TTTableViewController.h
-[TTTableViewDataSource]: http://github.com/facebook/three20/blob/master/src/Three20UI/Headers/TTTableViewDataSource.h
-[TTURLRequest]: http://github.com/facebook/three20/blob/master/src/Three20Network/Headers/TTURLRequest.h
-[TTTextEditor]: http://github.com/facebook/three20/blob/master/src/Three20UI/Headers/TTTextEditor.h
-[TTPickerTextField]: http://github.com/facebook/three20/blob/master/src/Three20UI/Headers/TTPickerTextField.h
-[TTNavigator]: http://github.com/facebook/three20/blob/master/src/Three20UI/Headers/TTNavigator.h
-[TTModule Python Script]: http://three20.info/article/2010-10-06-Adding-Three20-To-Your-Project
diff --git a/Three20.xcworkspace/contents.xcworkspacedata b/Three20.xcworkspace/contents.xcworkspacedata