Permalink
Browse files

update read me

  • Loading branch information...
1 parent 7d9ec78 commit 5a4f7d804ebf77250475782a48a67014163b7efe @steipete steipete committed Aug 1, 2012
Showing with 14 additions and 18 deletions.
  1. 0 HowTo.m → HowTo.md
  2. +14 −18 README.md
View
File renamed without changes.
View
@@ -1,42 +1,38 @@
PSCollectionView
================
-Open Source rewrite of UICollectionView for iOS4+
+Open Source, 100% API compatible replacement of UICollectionView for iOS4+
-This project has the goal to be a 100% API compatible* replacement for UICollectionView.
-The goal is to use it for fallback on iOS4/iOS5 and use "the real thing" on iOS6.
+The goal is to make UICollectionView instantly usable to anyone, using "the real thing" on iOS6 and PSCollectionView as a fallback for iOS4/5.
+We even use certain runtime tricks to create UICollectionView at runtime for older versions of iOS. Ideally, you just link the files and everything works on older systems.
+PSCollectionView is also internally designed very closesly to UICollectionView and thus a great study if you're wondering how UICollectionView works. See [HowTo](PSCollectionView/blob/master/HowTo.md) for helpful details.
-Since iSO6 is not yet released, this repository needs to be private to not break the NDA :/
+Currently there are still some problems, e.g. the cell that's either a subclass of PSCollectionViewCell or UICollectionViewCell, and there are problems for interoperabilty. [See Issue #1](https://github.com/steipete/PSCollectionView/issues/1)
+You can control if PSCollectionView should relay to UICollectionView with the global define `kPSCollectionViewRelayToUICollectionViewIfAvailable` in PSCollectionView.h.
-TODO:
-- Margins
-- Bugs with disappearing first cells
-- Performance (less recalculations)
-- Call more delegates, selection, highlighting
-- ...
+*Important: Since iSO6 is not yet released, this repository needs to be private to not break the NDA.*
-As cell animations are another super-tricky thing, my goal for now is to just don't animate.
-(But feel free to change that!)
+The current goal is to make layouts and all common features workable.
+Animations are a whole different problem, we might tackle them at a later date. (But feel free to start!)
-Should work with Xcode 4.4+ and ARC.
-
+PSCollectionView works with Xcode 4.4+ and ARC.
Feel free to hack around and improve it.
Another goal (at least super useful for debugging) is interoperability between UI/PS classes:
+``` objective-c
UICollectionViewFlowLayout *flowLayout = [UICollectionViewFlowLayout new];
PSCollectionView *collectionView = [PSCollectionView alloc] initWithFrame:self.view.bounds collectionViewLayout:(PSCollectionViewFlowLayout *)flowLayout];
+```
-
-(*) Note that for some methods we can't use the _ underscore variants or we risk to get a false-positive on private API use. I've added some runtime hacks to dynamcially add block forwarders for those cases (mainly for UI/PS interoperability)
+(*) Note that for some methods we can't use the _ underscore variants or we risk to get a false-positive on private API use. I've added some runtime hacks to dynamcially add block forwarders for those cases (mainly for UI/PS interoperability)
### Creator
[Peter Steinberger](http://github.com/steipete), [@steipete](https://twitter.com/steipete)
-
-and hopefully lots of others! See [HowTo](HowTo.m) for helpful details.
+and lots of others! See [Contributors](https://github.com/steipete/PSCollectionView/graphs/contributors) for a graph. Thanks everyone!
## License

0 comments on commit 5a4f7d8

Please sign in to comment.