Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Updated README.

  • Loading branch information...
commit 3fa44082ec6d6ac6d0a86986685c7c07386d9c2a 1 parent bd0c80d
Pontus Ekberg authored

Showing 1 changed file with 69 additions and 73 deletions. Show diff stats Hide diff stats

  1. +69 73 README
142 README
... ... @@ -1,76 +1,72 @@
1 1 - Comix README -
2 2
3   -About
4   -------------------------------------------------------------------------------
5   -Comix is a user-friendly, customizable image viewer. It is specifically
6   -designed to handle comic books, but also serves as a generic viewer. It reads
7   -images in ZIP, RAR or tar archives as well as plain image files. It is
8   -written in Python and uses GTK+ through the PyGTK bindings.
9   -
10   -
11   -Installation
12   -------------------------------------------------------------------------------
13   -Run "python install.py install" as root to install Comix in /usr/local.
14   -To uninstall, simply run "python install.py uninstall".
15   -
16   -If you wish to install Comix in another base directory, use the --dir option.
17   -
18   -Example:
19   -
20   - # python install.py --dir /usr install
21   -
22   -If you have installed with --dir, do not forget to use the same option when
23   -uninstalling.
24   -
25   -There is another option, --no-mime, that can be used to tell install.py that
26   -it should not register new mime types for cbz, cbr and cbt archives, or
27   -install the thumbnail creation script for these files that is used by some
28   -file managers (such as Nautilus and Thunar).
29   -
30   -As an example of how to install Comix from the downloaded tar.gz file, run
31   -as the root user (via su or sudo):
32   -
33   - # tar -xzf comix-x.y.tar.gz
34   - # cd comix-x.y
35   - # python install.py install
36   -
37   -If you don't want to install Comix in some system directory, you can just
38   -execute the file src/comix.py in the unpacked Comix directory to run the
39   -program. You could also create a symlink somewhere in your PATH pointing to
40   -this file.
41   -
42   -
43   -Dependencies
44   ---------------------------------------------------------------------------------
45   -Comix needs Python 2.4, PyGTK 2.12 and PIL (Python Imaging Library) 1.1.5 or
46   -newer to function.
47   -
48   -To use the library you need pysqlite (which is usually included in the
49   -standard library for Python 2.5 and later).
50   -
51   -You also need the "unrar" or the "rar" program installed if you wish to read
52   -RAR (.cbr) archives.
53   -
54   -
55   -Credits
56   ---------------------------------------------------------------------------------
57   -Thanks to everyone who have contributed translations, suggestions, bug
58   -reports, fixes and donations!
59   -
60   -Icons with a filename starting with "gimp" are taken from The GIMP, and icons
61   -with a filename starting with "tango" are taken from the Tango Desktop Project.
62   -Most other icons are made by Victor Castillejo, creator of the GNOME-Colors
63   -icon theme.
64   -
65   -
66   -Contact
67   ---------------------------------------------------------------------------------
68   -Pontus Ekberg <herrekberg@users.sourceforge.net>
69   -http://comix.sourceforge.net
70   -
71   -Don't hesitate to contact me.
72   -
73   -
74   ---------------------------------------------------------------------------------
75   -Have a nice day.
  3 +=== About =====================================================================
  4 +
  5 + Comix is a user-friendly, customizable image viewer. It is specifically
  6 + designed to handle comic books, but also serves as a generic viewer. It
  7 + reads images in ZIP, RAR or tar archives as well as plain image files. It
  8 + is written in Python and uses GTK+ through the PyGTK bindings.
  9 +
  10 +=== Installation ==============================================================
  11 +
  12 + Run "python install.py install" as root to install Comix in /usr/local.
  13 + To uninstall, simply run "python install.py uninstall".
  14 +
  15 + If order to install Comix in another base directory, use the --dir option.
  16 +
  17 + Example:
  18 +
  19 + # python install.py --dir /usr install
  20 +
  21 + If you have installed with --dir, do not forget to use the same option when
  22 + uninstalling.
  23 +
  24 + There is another option, --no-mime, that can be used to tell install.py that
  25 + it should not register new mime types for cbz, cbr and cbt archives, or
  26 + install the thumbnail creation script for these files that is used by some
  27 + file managers (such as Nautilus and Thunar).
  28 +
  29 + As an example of how to install Comix from the downloaded tar.gz file, run
  30 + as the root user (via su or sudo):
  31 +
  32 + # tar -xzf comix-x.y.tar.gz
  33 + # cd comix-x.y
  34 + # python install.py install
  35 +
  36 + If you don't want to install Comix in some system directory, you can just
  37 + execute the file src/comix.py in the unpacked Comix directory to run the
  38 + program. You could also create a symlink somewhere in your PATH pointing to
  39 + this file.
  40 +
  41 +=== Dependencies ==============================================================
  42 +
  43 + Comix needs Python 2.4, PyGTK 2.12 and PIL (Python Imaging Library) 1.1.5 or
  44 + newer to function.
  45 +
  46 + To use the library you need pysqlite (which is usually included in the
  47 + standard library for Python 2.5 and later).
  48 +
  49 + You also need either the "unrar" or the "rar" program installed if you wish
  50 + to read RAR (.cbr) archives.
  51 +
  52 +=== Credits ===================================================================
  53 +
  54 + Thanks to everyone who have contributed translations, suggestions, bug
  55 + reports, fixes and donations!
  56 +
  57 + Icons with a filename starting with "gimp" are taken from The GIMP, and
  58 + icons with a filename starting with "tango" are taken from the Tango Desktop
  59 + Project. Most other icons are made by Victor Castillejo, creator of the
  60 + GNOME-Colors icon theme.
  61 +
  62 +=== Contact ===================================================================
  63 +
  64 + Pontus Ekberg <herrekberg@users.sourceforge.net>
  65 + http://comix.sourceforge.net
  66 +
  67 + Don't hesitate to contact me.
  68 +
  69 +===============================================================================
  70 +
  71 + Have a nice day.
76 72

0 comments on commit 3fa4408

Please sign in to comment.
Something went wrong with that request. Please try again.