Added a "git push" dialog
[ugit.git] / README
blobf65babb5fff24cdd54367814994ad9a10eebe378
1 ugit: A PyQt-based git gui
3 ugit began as a PyQt re-implementation of git-gui.
4 It has an evolving feature set and aims to be a full-featured
5 companion to the existing git uis.
8 ugit is Copyright (C) 2007 David Aguilar
10 This program is free software: you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation, either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program.  If not, see <http://www.gnu.org/licenses/>.
24 REQUIREMENTS:
26 python >= 2.4
27 pyqt   >= 4.3
30 INSTALLING UGIT:
32         ./configure --prefix=/usr
33         make && sudo make install
36 Assuming python is version 2.4, "make install" installs ugit here:
38         /usr/local/bin/ugit linked to ugit.py
39         /usr/local/lib/python2.4/site-packages/ugitlibs/
42 For example:
44 If for some reason ugit.py is unable to locate its
45 libraries, add the site-packages directory to your $PYTHONPATH.
47 PYTHONPATH=/usr/local/lib/python2.4/site-packages
48 export PYTHON
51 WINDOWS SUPPORT
53 Windows supported is experimental at the moment.
54 As git's windows support improves, so will ugit's.
56 The ugit gui itself has run successfully on win32.
58 1) Get the Python2.5 installer:
59         http://python.org/download/
61 2) Get the PyQt4 installer:
62         http://www.riverbankcomputing.co.uk/pyqt/download.php
64 3) Get git:
65         I've only tested cygwin.
66         http://git.or.cz/
67         http://git.or.cz/gitwiki/WindowsInstall
68         http://en.wikipedia.org/wiki/Git_(software)#Portability
70 4) Get ugit:
71         Download any of the win32 tarballs here:
72                 http://ugit.justroots.com/
73         ..and run the ugit-cygwin.sh script.
74         The script assumes the you have Python/PyQt4 installed in
75         C:\Python25.  If that is not the case, edit the script accordingly.
77         voila, ugit on Windows.
80 ICON ACKNOWLEDGEMENTS:
82 staged.png is from the "slick" KDE icon set.
83 All other icons are from the Apache httpd server icon set.
84 These icons carry the following license:
86                                  Apache License
87                            Version 2.0, January 2004
88                         http://www.apache.org/licenses/
90    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
92    1. Definitions.
94       "License" shall mean the terms and conditions for use, reproduction,
95       and distribution as defined by Sections 1 through 9 of this document.
97       "Licensor" shall mean the copyright owner or entity authorized by
98       the copyright owner that is granting the License.
100       "Legal Entity" shall mean the union of the acting entity and all
101       other entities that control, are controlled by, or are under common
102       control with that entity. For the purposes of this definition,
103       "control" means (i) the power, direct or indirect, to cause the
104       direction or management of such entity, whether by contract or
105       otherwise, or (ii) ownership of fifty percent (50%) or more of the
106       outstanding shares, or (iii) beneficial ownership of such entity.
108       "You" (or "Your") shall mean an individual or Legal Entity
109       exercising permissions granted by this License.
111       "Source" form shall mean the preferred form for making modifications,
112       including but not limited to software source code, documentation
113       source, and configuration files.
115       "Object" form shall mean any form resulting from mechanical
116       transformation or translation of a Source form, including but
117       not limited to compiled object code, generated documentation,
118       and conversions to other media types.
120       "Work" shall mean the work of authorship, whether in Source or
121       Object form, made available under the License, as indicated by a
122       copyright notice that is included in or attached to the work
123       (an example is provided in the Appendix below).
125       "Derivative Works" shall mean any work, whether in Source or Object
126       form, that is based on (or derived from) the Work and for which the
127       editorial revisions, annotations, elaborations, or other modifications
128       represent, as a whole, an original work of authorship. For the purposes
129       of this License, Derivative Works shall not include works that remain
130       separable from, or merely link (or bind by name) to the interfaces of,
131       the Work and Derivative Works thereof.
133       "Contribution" shall mean any work of authorship, including
134       the original version of the Work and any modifications or additions
135       to that Work or Derivative Works thereof, that is intentionally
136       submitted to Licensor for inclusion in the Work by the copyright owner
137       or by an individual or Legal Entity authorized to submit on behalf of
138       the copyright owner. For the purposes of this definition, "submitted"
139       means any form of electronic, verbal, or written communication sent
140       to the Licensor or its representatives, including but not limited to
141       communication on electronic mailing lists, source code control systems,
142       and issue tracking systems that are managed by, or on behalf of, the
143       Licensor for the purpose of discussing and improving the Work, but
144       excluding communication that is conspicuously marked or otherwise
145       designated in writing by the copyright owner as "Not a Contribution."
147       "Contributor" shall mean Licensor and any individual or Legal Entity
148       on behalf of whom a Contribution has been received by Licensor and
149       subsequently incorporated within the Work.
151    2. Grant of Copyright License. Subject to the terms and conditions of
152       this License, each Contributor hereby grants to You a perpetual,
153       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
154       copyright license to reproduce, prepare Derivative Works of,
155       publicly display, publicly perform, sublicense, and distribute the
156       Work and such Derivative Works in Source or Object form.
158    3. Grant of Patent License. Subject to the terms and conditions of
159       this License, each Contributor hereby grants to You a perpetual,
160       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
161       (except as stated in this section) patent license to make, have made,
162       use, offer to sell, sell, import, and otherwise transfer the Work,
163       where such license applies only to those patent claims licensable
164       by such Contributor that are necessarily infringed by their
165       Contribution(s) alone or by combination of their Contribution(s)
166       with the Work to which such Contribution(s) was submitted. If You
167       institute patent litigation against any entity (including a
168       cross-claim or counterclaim in a lawsuit) alleging that the Work
169       or a Contribution incorporated within the Work constitutes direct
170       or contributory patent infringement, then any patent licenses
171       granted to You under this License for that Work shall terminate
172       as of the date such litigation is filed.
174    4. Redistribution. You may reproduce and distribute copies of the
175       Work or Derivative Works thereof in any medium, with or without
176       modifications, and in Source or Object form, provided that You
177       meet the following conditions:
179       (a) You must give any other recipients of the Work or
180           Derivative Works a copy of this License; and
182       (b) You must cause any modified files to carry prominent notices
183           stating that You changed the files; and
185       (c) You must retain, in the Source form of any Derivative Works
186           that You distribute, all copyright, patent, trademark, and
187           attribution notices from the Source form of the Work,
188           excluding those notices that do not pertain to any part of
189           the Derivative Works; and
191       (d) If the Work includes a "NOTICE" text file as part of its
192           distribution, then any Derivative Works that You distribute must
193           include a readable copy of the attribution notices contained
194           within such NOTICE file, excluding those notices that do not
195           pertain to any part of the Derivative Works, in at least one
196           of the following places: within a NOTICE text file distributed
197           as part of the Derivative Works; within the Source form or
198           documentation, if provided along with the Derivative Works; or,
199           within a display generated by the Derivative Works, if and
200           wherever such third-party notices normally appear. The contents
201           of the NOTICE file are for informational purposes only and
202           do not modify the License. You may add Your own attribution
203           notices within Derivative Works that You distribute, alongside
204           or as an addendum to the NOTICE text from the Work, provided
205           that such additional attribution notices cannot be construed
206           as modifying the License.
208       You may add Your own copyright statement to Your modifications and
209       may provide additional or different license terms and conditions
210       for use, reproduction, or distribution of Your modifications, or
211       for any such Derivative Works as a whole, provided Your use,
212       reproduction, and distribution of the Work otherwise complies with
213       the conditions stated in this License.
215    5. Submission of Contributions. Unless You explicitly state otherwise,
216       any Contribution intentionally submitted for inclusion in the Work
217       by You to the Licensor shall be under the terms and conditions of
218       this License, without any additional terms or conditions.
219       Notwithstanding the above, nothing herein shall supersede or modify
220       the terms of any separate license agreement you may have executed
221       with Licensor regarding such Contributions.
223    6. Trademarks. This License does not grant permission to use the trade
224       names, trademarks, service marks, or product names of the Licensor,
225       except as required for reasonable and customary use in describing the
226       origin of the Work and reproducing the content of the NOTICE file.
228    7. Disclaimer of Warranty. Unless required by applicable law or
229       agreed to in writing, Licensor provides the Work (and each
230       Contributor provides its Contributions) on an "AS IS" BASIS,
231       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
232       implied, including, without limitation, any warranties or conditions
233       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
234       PARTICULAR PURPOSE. You are solely responsible for determining the
235       appropriateness of using or redistributing the Work and assume any
236       risks associated with Your exercise of permissions under this License.
238    8. Limitation of Liability. In no event and under no legal theory,
239       whether in tort (including negligence), contract, or otherwise,
240       unless required by applicable law (such as deliberate and grossly
241       negligent acts) or agreed to in writing, shall any Contributor be
242       liable to You for damages, including any direct, indirect, special,
243       incidental, or consequential damages of any character arising as a
244       result of this License or out of the use or inability to use the
245       Work (including but not limited to damages for loss of goodwill,
246       work stoppage, computer failure or malfunction, or any and all
247       other commercial damages or losses), even if such Contributor
248       has been advised of the possibility of such damages.
250    9. Accepting Warranty or Additional Liability. While redistributing
251       the Work or Derivative Works thereof, You may choose to offer,
252       and charge a fee for, acceptance of support, warranty, indemnity,
253       or other liability obligations and/or rights consistent with this
254       License. However, in accepting such obligations, You may act only
255       on Your own behalf and on Your sole responsibility, not on behalf
256       of any other Contributor, and only if You agree to indemnify,
257       defend, and hold each Contributor harmless for any liability
258       incurred by, or claims asserted against, such Contributor by reason
259       of your accepting any such warranty or additional liability.