source: tags/0.2.2/README @ 324

Revision 324, 3.0 KB checked in by marc, 8 years ago (diff)

First try at backport

Line 
1Itaka
2Version 0.2.2
3
4http://itaka.jardinpresente.com.ar
5
6CONTENTS:
7---------
81. ABOUT ITAKA
92. REQUIRED LIBRARIES
103. INSTALLATION
114. DEBIAN PACKAGE
125. DOCUMENTATION
136. HACKING
147. RELEASE NOTES
158. PROGRAM CREDITS
16
171. ABOUT ITAKA:
18
19Itaka is an on-demand screen capture server for Windows, Mac Os X and Linux. It is developed in Python, PyGTK and the Twisted Framework. It prominently features a polished easy to use interface, with a robust backend server.
20
212. REQUIRED LIBRARIES:
22
23Itaka requires the following programs/libraries.
24
25- Python 2.3 or higher
26- PyGTK 2.10.0 or higher
27- Twisted 2.2.0 or higher
28
29- GTK 2.10 or higher
30
313. INSTALLATION:
32Itaka needs to be installed as the root user.
33
34Unpack and install the Itaka tarball using these commands:
35
36   'tar -xjvf <packagename>.tar.bz2'
37
38Switch to the newly created directory and type 'make install' as root and the
39Makefile will copy the files to the correct location in your system. You do not
40need to configure or compile Itaka as it is written in interpreted Python code.
41
42By default itaka will be installed in /usr/local/, if you want to use another location, add PREFIX=/usr/mylocation after every make command, including unnstall.
43
44Example: make PREFIX=/usr
45
46To uninstall, once again as root type 'make uninstall'
47
484. DEBIAN PACKAGE:
49
50To create the Debian package simply do:
51
52    # Make sure you have your gpg keys and debian development environment correctly setup
53    # You must also package the itaka source as a tarball per debian guidelines.
54
55    debuild
56
575. DOCUMENTATION:
58
59Itaka uses Epytext Markup Language to comment its code.
60
61You can ownload epydoc from http://epydoc.sourceforge.net/
62
63You can generate documentation using epydoc.
64
65mkdir doc
66epydoc --html -o doc -n Itaka -u "http://itaka.jardinpresente.com.ar" *.py
67
686. HACKING
69
70If you intend to change Itaka source code, please read the HACKING file.
71
72Any questions should be emailed to me directly.
73
747. RELEASE NOTES:
75
76See the ChangeLog for more detailed information.
77
78Donations for this software would be greatly appreciated. This software is totally free, but sending a few dollars via PayPal would be nice.
79
80Please visit http://itaka.jardinpresente.com.ar to donate.
81
82This program is released under the GNU/GPL License version 3.
83
84See COPYING file for further license information.
85
868. PROGRAM CREDITS:
87
88Special thanks to James Henstridge for the excellent Python-GTK bindings and their equally excellent documentation.
89
90Thanks to the #pygtk and #gtk+ channels on irc.gimp.org and the #python and #twisted channels on irc.freenode.net for their help.
91
92Thanks to Kurt Erickson for the RPM packages and to Nicoleau Fabien for including Itaka in Fedora.
93
94Thanks to Nahuel and Ezequiel for his continuing support and inspiration.
95
96Itaka's icon is based upon the work of the Tango Project and is follows their licensing.
97
98This README file and the Makefile are based on the works of the BloGTK project (http://blogtk.sourceforge.net)
99
100Thanks to all Itaka users for bug reports, feature requests, and their support of this application.
101
102See AUTHORS and COPYRIGHT files for further credit information.
Note: See TracBrowser for help on using the repository browser.