Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 78 lines (55 sloc) 2.687 kB
3b120b4 @dmpatierno Updated README
dmpatierno authored
1 == The Official iFixit iOS App ==
b898cff @dmpatierno Change README to plaintext
dmpatierno authored
2
3 This is a native iPad guide viewer built using iFixit's public APIs at
4 http://www.ifixit.com/api
9e6d250 @dmpatierno Initial commit.
dmpatierno authored
5
3b120b4 @dmpatierno Updated README
dmpatierno authored
6 APIs used:
7 * /api/areas
b83c741 @dmpatierno Update README with API list
dmpatierno authored
8 * /api/guides
9 * /api/device
3b120b4 @dmpatierno Updated README
dmpatierno authored
10 * /api/guide
b83c741 @dmpatierno Update README with API list
dmpatierno authored
11 * /api/search
12 * /api/likes
3b120b4 @dmpatierno Updated README
dmpatierno authored
13
14 ----------
15
16 CONTRIBUTING
b898cff @dmpatierno Change README to plaintext
dmpatierno authored
17
18 This app is just the beginning. It only implements a small subset of iFixit's
19 functionality: the native view of a repair guide. We'd love to do all sorts of other
20 things, too. Here's a wishlist:
3b120b4 @dmpatierno Updated README
dmpatierno authored
21 * Create nifty splash home screen, rather than defaulting to web view
22 * Add native search
23 * Store repair guides offline, so you don't need a net connection to fix things
b898cff @dmpatierno Change README to plaintext
dmpatierno authored
24 * Add native views for Area pages and Device pages, removing most of the need for web
25 views.
3b120b4 @dmpatierno Updated README
dmpatierno authored
26 * Allow browsing and adding notes
27 * iPhone support
28
b898cff @dmpatierno Change README to plaintext
dmpatierno authored
29 We have a small development team, and don't have the resources to do all of these
30 ourselves. We'd love help! If any of those problems looks interesting to you, fork our
31 code and hack away!
3b120b4 @dmpatierno Updated README
dmpatierno authored
32
b898cff @dmpatierno Change README to plaintext
dmpatierno authored
33 Got an awesome feature idea that we don't have an API to support yet? Post the request on
34 meta.ifixit.com and we'll add it to our to-do list.
3b120b4 @dmpatierno Updated README
dmpatierno authored
35
36 ----------
37
38 BUILD NOTES
39
40 If you are building this for your own phone, then please note that
41 you must modify the iFixit-Info.plist file to build with
42 your own credentials.
43
44 ----------
45
46 TRADEMARK NOTES
47
b898cff @dmpatierno Change README to plaintext
dmpatierno authored
48 All iFixit trademarks contained herein are NOT licensed for use by any third-parties.
49 Their inclusion in this open source software is only for their eventual replacement if
50 you distribute the application.
3b120b4 @dmpatierno Updated README
dmpatierno authored
51
b898cff @dmpatierno Change README to plaintext
dmpatierno authored
52 That is, the trademarks are protected, but the code itself is under an open license. You
53 can use the trademarks individually, but not for any sort of distribution.
3b120b4 @dmpatierno Updated README
dmpatierno authored
54
55 Copyright (c) 2010 iFixit
56
57 ----------
58
59 LICENSING
60
61 This source code is dual-licensed under the GPLv3 and the CDDL.
62
b898cff @dmpatierno Change README to plaintext
dmpatierno authored
63 Why two licenses? The GPL does not allow additional restrictions to the license, and
64 Apple's App Store Terms of Service are incompatible. So to make sure that you can modify
65 this source code and submit new apps to Apple, we're also releasing it under the Common
66 Development and Distribution License (CDDL), which *is* compatible with Apple's Terms of
67 Service.
3b120b4 @dmpatierno Updated README
dmpatierno authored
68
69 Any submissions to this project must also be licensed under both GPL and CDDL.
70
b898cff @dmpatierno Change README to plaintext
dmpatierno authored
71 The contents of this software are subject to the terms of the Common Development and
72 Distribution License and the GNU General Public License (the "License"). You may not use
73 this software except in compliance with the Licenses. You can obtain a copy of the
74 licenses at http://www.sun.com/cddl/cddl.html and http://www.gnu.org/licenses/gpl-3.0.txt
3b120b4 @dmpatierno Updated README
dmpatierno authored
75
b898cff @dmpatierno Change README to plaintext
dmpatierno authored
76 See the License for the specific language governing permissions and limitations under the
77 License.
Something went wrong with that request. Please try again.