Menu

Tree [46f1cd] master /
 History

HTTPS access


File Date Author Commit
 debian 2010-05-09 Yura Tolstik Yura Tolstik [fc36ca] prepare all for debian package
 examples 2008-12-24 Serge Matveenko Serge Matveenko [1ca5c4] profiled demo added
 src 2010-05-09 Yura Tolstik Yura Tolstik [03475f] fix DeprecationWarning: the md5 module is depre...
 tests 2009-01-01 Serge Matveenko Serge Matveenko [c00eda] minor regex idx parsing refactoring
 .gitignore 2010-05-14 Serge Matveenko Serge Matveenko [3598bc] Add hidden files to .gitignore.
 COPYING 2008-12-09 Serge Matveenko Serge Matveenko [e4447a] copying rights information added
 MANIFEST.in 2008-12-11 Serge Matveenko Serge Matveenko [235ac5] version 0.2 released
 MILESTONES 2009-01-01 Serge Matveenko Serge Matveenko [c00eda] minor regex idx parsing refactoring
 README 2010-05-14 Serge Matveenko Serge Matveenko [46f1cd] Add contributors to authors list.
 setup.py 2009-01-01 Serge Matveenko Serge Matveenko [badd81] version number changed to 0.5
 test.py 2008-12-10 Serge Matveenko Serge Matveenko [985b0a] Merge branch 'unittest'

Read Me

Copyright 2008-2010 Serge Matveenko

This file is part of PyStarDict.

PyStarDict is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

PyStarDict is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with PyStarDict.  If not, see <http://www.gnu.org/licenses/>.

PyStarDict README
=================

Home page
---------

<http://www.ohloh.net/p/pystardict>

Authors
-------

Serge Matveenko <s@matveenko.ru>, Maksim Zakharov <python.candidate@gmail.com>,
Yura Tolstik <yltsrc@gmail.com>

Installation
------------

_This is short installation instructions for PyStarDict._

1. Install Python

  <http://python.org/>

2. Download latest version of PyStarDict

  <http://sourceforge.net/project/platformdownload.php?group_id=247655>

3. Extract files from the archive

  `tar xvf PyStarDict-version.tar.gz`

4. Change working directory to the new one

  `cd PyStarDict-version`

6. Install PyStarDict

  `python setup.py install --prefix=/local/prefix`

  _**Note**: `--prefix` is optional_

You are done!

How to use
----------

For working example look into `examples` directory at the `demo.py` file.
Examples are installed in the `/local/prefix/share/pystardict` directory, where
`/local/prefix` is your installation prefix.

How to contribute
-----------------

* Fill free to report any bugs or attach patches here:

  <https://sourceforge.net/tracker/?group_id=247655&atid=1126317>

* Or send you patches by email:

  <git@matveenko.ru>

Style Guide for PyStarDict Code
-------------------------------

* Respect PEP 8 -- Style Guide for Python Code

* Use Markdown for stand alone documentation files, render them to HTML and
keep both files

* Use `@` symbol for `todo`s and other pydoc tags

* Use `@author` tag if you have modified some file
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.