Renamed files in preparation for api changes
[ugit.git] / README
blobea93b804eeae5ea016b373d106c17b17c4edb450
1 ugit: ugit's git-gui's inner truffles
3 ugit started out as a python/pyqt re-implementation of git-gui.
4 It has an evolving feature set and aims to be a fully-featured
5 companion to the existing git uis.
7 DEPENDENCIES:
8 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
9         python 2.4.x
10         pyqt 4.3.x
11         pyqtmvc 1.1.x
14 ABOUT THE ICONS:
15 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
17 staged.png was blatanly stolen from the "slick" KDE icon set.
19 All other icons blatanly stolen from Apache's icons:
20 These icons are covered by the following copyright license:
22                                  Apache License
23                            Version 2.0, January 2004
24                         http://www.apache.org/licenses/
26    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
28    1. Definitions.
30       "License" shall mean the terms and conditions for use, reproduction,
31       and distribution as defined by Sections 1 through 9 of this document.
33       "Licensor" shall mean the copyright owner or entity authorized by
34       the copyright owner that is granting the License.
36       "Legal Entity" shall mean the union of the acting entity and all
37       other entities that control, are controlled by, or are under common
38       control with that entity. For the purposes of this definition,
39       "control" means (i) the power, direct or indirect, to cause the
40       direction or management of such entity, whether by contract or
41       otherwise, or (ii) ownership of fifty percent (50%) or more of the
42       outstanding shares, or (iii) beneficial ownership of such entity.
44       "You" (or "Your") shall mean an individual or Legal Entity
45       exercising permissions granted by this License.
47       "Source" form shall mean the preferred form for making modifications,
48       including but not limited to software source code, documentation
49       source, and configuration files.
51       "Object" form shall mean any form resulting from mechanical
52       transformation or translation of a Source form, including but
53       not limited to compiled object code, generated documentation,
54       and conversions to other media types.
56       "Work" shall mean the work of authorship, whether in Source or
57       Object form, made available under the License, as indicated by a
58       copyright notice that is included in or attached to the work
59       (an example is provided in the Appendix below).
61       "Derivative Works" shall mean any work, whether in Source or Object
62       form, that is based on (or derived from) the Work and for which the
63       editorial revisions, annotations, elaborations, or other modifications
64       represent, as a whole, an original work of authorship. For the purposes
65       of this License, Derivative Works shall not include works that remain
66       separable from, or merely link (or bind by name) to the interfaces of,
67       the Work and Derivative Works thereof.
69       "Contribution" shall mean any work of authorship, including
70       the original version of the Work and any modifications or additions
71       to that Work or Derivative Works thereof, that is intentionally
72       submitted to Licensor for inclusion in the Work by the copyright owner
73       or by an individual or Legal Entity authorized to submit on behalf of
74       the copyright owner. For the purposes of this definition, "submitted"
75       means any form of electronic, verbal, or written communication sent
76       to the Licensor or its representatives, including but not limited to
77       communication on electronic mailing lists, source code control systems,
78       and issue tracking systems that are managed by, or on behalf of, the
79       Licensor for the purpose of discussing and improving the Work, but
80       excluding communication that is conspicuously marked or otherwise
81       designated in writing by the copyright owner as "Not a Contribution."
83       "Contributor" shall mean Licensor and any individual or Legal Entity
84       on behalf of whom a Contribution has been received by Licensor and
85       subsequently incorporated within the Work.
87    2. Grant of Copyright License. Subject to the terms and conditions of
88       this License, each Contributor hereby grants to You a perpetual,
89       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
90       copyright license to reproduce, prepare Derivative Works of,
91       publicly display, publicly perform, sublicense, and distribute the
92       Work and such Derivative Works in Source or Object form.
94    3. Grant of Patent License. Subject to the terms and conditions of
95       this License, each Contributor hereby grants to You a perpetual,
96       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
97       (except as stated in this section) patent license to make, have made,
98       use, offer to sell, sell, import, and otherwise transfer the Work,
99       where such license applies only to those patent claims licensable
100       by such Contributor that are necessarily infringed by their
101       Contribution(s) alone or by combination of their Contribution(s)
102       with the Work to which such Contribution(s) was submitted. If You
103       institute patent litigation against any entity (including a
104       cross-claim or counterclaim in a lawsuit) alleging that the Work
105       or a Contribution incorporated within the Work constitutes direct
106       or contributory patent infringement, then any patent licenses
107       granted to You under this License for that Work shall terminate
108       as of the date such litigation is filed.
110    4. Redistribution. You may reproduce and distribute copies of the
111       Work or Derivative Works thereof in any medium, with or without
112       modifications, and in Source or Object form, provided that You
113       meet the following conditions:
115       (a) You must give any other recipients of the Work or
116           Derivative Works a copy of this License; and
118       (b) You must cause any modified files to carry prominent notices
119           stating that You changed the files; and
121       (c) You must retain, in the Source form of any Derivative Works
122           that You distribute, all copyright, patent, trademark, and
123           attribution notices from the Source form of the Work,
124           excluding those notices that do not pertain to any part of
125           the Derivative Works; and
127       (d) If the Work includes a "NOTICE" text file as part of its
128           distribution, then any Derivative Works that You distribute must
129           include a readable copy of the attribution notices contained
130           within such NOTICE file, excluding those notices that do not
131           pertain to any part of the Derivative Works, in at least one
132           of the following places: within a NOTICE text file distributed
133           as part of the Derivative Works; within the Source form or
134           documentation, if provided along with the Derivative Works; or,
135           within a display generated by the Derivative Works, if and
136           wherever such third-party notices normally appear. The contents
137           of the NOTICE file are for informational purposes only and
138           do not modify the License. You may add Your own attribution
139           notices within Derivative Works that You distribute, alongside
140           or as an addendum to the NOTICE text from the Work, provided
141           that such additional attribution notices cannot be construed
142           as modifying the License.
144       You may add Your own copyright statement to Your modifications and
145       may provide additional or different license terms and conditions
146       for use, reproduction, or distribution of Your modifications, or
147       for any such Derivative Works as a whole, provided Your use,
148       reproduction, and distribution of the Work otherwise complies with
149       the conditions stated in this License.
151    5. Submission of Contributions. Unless You explicitly state otherwise,
152       any Contribution intentionally submitted for inclusion in the Work
153       by You to the Licensor shall be under the terms and conditions of
154       this License, without any additional terms or conditions.
155       Notwithstanding the above, nothing herein shall supersede or modify
156       the terms of any separate license agreement you may have executed
157       with Licensor regarding such Contributions.
159    6. Trademarks. This License does not grant permission to use the trade
160       names, trademarks, service marks, or product names of the Licensor,
161       except as required for reasonable and customary use in describing the
162       origin of the Work and reproducing the content of the NOTICE file.
164    7. Disclaimer of Warranty. Unless required by applicable law or
165       agreed to in writing, Licensor provides the Work (and each
166       Contributor provides its Contributions) on an "AS IS" BASIS,
167       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
168       implied, including, without limitation, any warranties or conditions
169       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
170       PARTICULAR PURPOSE. You are solely responsible for determining the
171       appropriateness of using or redistributing the Work and assume any
172       risks associated with Your exercise of permissions under this License.
174    8. Limitation of Liability. In no event and under no legal theory,
175       whether in tort (including negligence), contract, or otherwise,
176       unless required by applicable law (such as deliberate and grossly
177       negligent acts) or agreed to in writing, shall any Contributor be
178       liable to You for damages, including any direct, indirect, special,
179       incidental, or consequential damages of any character arising as a
180       result of this License or out of the use or inability to use the
181       Work (including but not limited to damages for loss of goodwill,
182       work stoppage, computer failure or malfunction, or any and all
183       other commercial damages or losses), even if such Contributor
184       has been advised of the possibility of such damages.
186    9. Accepting Warranty or Additional Liability. While redistributing
187       the Work or Derivative Works thereof, You may choose to offer,
188       and charge a fee for, acceptance of support, warranty, indemnity,
189       or other liability obligations and/or rights consistent with this
190       License. However, in accepting such obligations, You may act only
191       on Your own behalf and on Your sole responsibility, not on behalf
192       of any other Contributor, and only if You agree to indemnify,
193       defend, and hold each Contributor harmless for any liability
194       incurred by, or claims asserted against, such Contributor by reason
195       of your accepting any such warranty or additional liability.