sekouperry / ifixit-ios Goto Github PK

== The Official iFixit iOS App ==

This is a native iPad guide viewer built using iFixit's public APIs at
http://www.ifixit.com/api

APIs used:
 * /api/areas
 * /api/guides
 * /api/device
 * /api/guide
 * /api/search
 * /api/likes
 
----------

CONTRIBUTING

This app is just the beginning. It only implements a small subset of iFixit's
functionality: the native view of a repair guide. We'd love to do all sorts of other
things, too. Here's a wishlist:
 * Create nifty splash home screen, rather than defaulting to web view
 * Add native search
 * Store repair guides offline, so you don't need a net connection to fix things
 * Add native views for Area pages and Device pages, removing most of the need for web
   views.
 * Allow browsing and adding notes
 * iPhone support
 
We have a small development team, and don't have the resources to do all of these
ourselves. We'd love help! If any of those problems looks interesting to you, fork our
code and hack away!

Got an awesome feature idea that we don't have an API to support yet? Post the request on
meta.ifixit.com and we'll add it to our to-do list.

----------

BUILD NOTES

If you are building this for your own phone, then please note that
you must modify the iFixit-Info.plist file to build with
your own credentials.

----------

TRADEMARK NOTES

All iFixit trademarks contained herein are NOT licensed for use by any third-parties.
Their inclusion in this open source software is only for their eventual replacement if
you distribute the application.

That is, the trademarks are protected, but the code itself is under an open license. You
can use the trademarks individually, but not for any sort of distribution.

Copyright (c) 2010 iFixit

----------

LICENSING

This source code is dual-licensed under the GPLv3 and the CDDL.

Why two licenses? The GPL does not allow additional restrictions to the license, and
Apple's App Store Terms of Service are incompatible. So to make sure that you can modify
this source code and submit new apps to Apple, we're also releasing it under the Common
Development and Distribution License (CDDL), which *is* compatible with Apple's Terms of
Service.

Any submissions to this project must also be licensed under both GPL and CDDL.

The contents of this software are subject to the terms of the Common Development and
Distribution License and the GNU General Public License (the "License"). You may not use
this software except in compliance with the Licenses. You can obtain a copy of the
licenses at http://www.sun.com/cddl/cddl.html and http://www.gnu.org/licenses/gpl-3.0.txt

See the License for the specific language governing permissions and limitations under the
License.