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 <[email protected]>, Maksim Zakharov <[email protected]>,
Yura Tolstik <[email protected]>
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:
<[email protected]>
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