diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..43ae0e2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +__pycache__/ +*.py[cod] diff --git a/README b/README.rst similarity index 88% rename from README rename to README.rst index 3c61030..703d1cf 100644 --- a/README +++ b/README.rst @@ -4,7 +4,7 @@ pyGTKtalog pyGTKtalog is Linux/FreeBSD program for indexing CD/DVD or directories on filesystem. It is similar to `gtktalog `_ or `gwhere `_. There is no coincidence in name of -application, because it's menat to be replacement (in some way) for gtktalog, +application, because it's meant to be replacement (in some way) for gtktalog, which seems to be dead project for years. Current version is 1.9. @@ -31,18 +31,18 @@ pyGTKtalog requires python and following libraries: * `pygtkmvc 1.99 `_ * `sqlalchemy 0.6 `_ -It may work on other (lower) version of libraries, and it should work with +It may work on other (lower) version of libraries, and it should work with higher versions of libraries. .. note:: - Although pygtkmvc is `listed on pypi + Although pygtkmvc is `listed on pypi `_ it may happen that you have to download it directly from `sourceforge `_ page and install manually. I don't know about pygtk (I've installed it by my - system package manager), but all the others python libraries (sqlalchemy, - paver, nose, coverage) should be installable via `pip + system package manager), but all the others python libraries (sqlalchemy, + paver, nose, coverage) should be installable via `pip `_ Optional modules @@ -50,12 +50,12 @@ Optional modules * `PIL `_ for image manipulation -Additional pyGTKtalog uses EXIF module by Gene Cash (slightly updatetd to EXIF +Additional pyGTKtalog uses EXIF module by Gene Cash (slightly updated to EXIF 2.2 by me) which is included in sources. -pyGTKtalog extensivly uses external programs in unix spirit, however there is +pyGTKtalog extensively uses external programs in unix spirit, however there is small possibility of using it Windows (probably with limitations) and quite big -possiblity to run it on other sofisticated unix-like systems (i.e. +possibility to run it on other sophisticated unix-like systems (i.e. BeOS/ZETA/Haiku, QNX or MacOSX). Programs that are used: @@ -113,9 +113,9 @@ For version 2.0: * command line support: query, adding media to collection etc * internationalization * export to XLS -* user definied group of tags (represented by color in cloud tag) -* hiding specified files - configurable, like dot prefixed, cfg and manualy - selected +* user defined group of tags (represented by color in cloud tag) +* hiding specified files - configurable, like dot prefixed, config and + manually selected * tests * warning about existing image in media directory @@ -153,7 +153,7 @@ public release there will be no other formats so it will be useless, and deleted. There are some issues with converting. All thumbnails will be lost. All images without big image will be lost. There are serious changes with application design, and I decided, that is better to keep media unpacked on -disk, instead of pack it every time with save and unpack with open methods. New +disk, instead of pack it every time with save and unpack with open methods. New design prevent from deleting any file from media directory (placed in ``~/.pygtktalog/images``). Functionality for exporting images and corresponding db file is planned. @@ -169,14 +169,11 @@ Paver I've choose `Paver `_ as make equivalent. Inside main project directory there is pavement.py script, which -provides several tasks, that can be helpfull in a work with sources. Paver is +provides several tasks, that can be helpful in a work with sources. Paver is also used to generate standard setup.py. -Nose -^^^^ - -BUGS ----- - -All bugs please report to Roman 'gryf' Dobosz . +LICENSE +======= +This work is licensed under the terms of the GNU GPL, version 3. See the LICENCE +file in top-level directory.