/usr/share/doc/pyqso/README.md is in pyqso 0.3-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | Copyright (C) 2013-2016 Christian T. Jacobs.
This file is part of PyQSO.
PyQSO 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.
PyQSO 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 PyQSO. If not, see <http://www.gnu.org/licenses/>.
PyQSO
=====
PyQSO is a contact logging tool for amateur radio operators.
[](https://travis-ci.org/ctjacobs/pyqso)
[](https://readthedocs.org/projects/pyqso/?badge=latest)
Installation and running
------------------------
Assuming that the current working directory is PyQSO's base directory (the directory that the Makefile is in), PyQSO can be installed via the terminal with the following command:
`make install`
Note: 'sudo' may be needed for this. Once installed, the following command will run PyQSO:
`pyqso`
Alternatively, PyQSO can be run (without installing) with:
`python3 bin/pyqso`
from PyQSO's base directory.
Documentation
-------------
The PyQSO documentation is stored in the `docs` directory. It can be built with the following command:
`make docs`
which will produce an HTML version of the documentation in `docs/build/html` that can be opened in a web browser.
Alternatively, a ready-built version of the PyQSO documentation can be found on [Read the Docs](http://pyqso.readthedocs.io/).
Dependencies
------------
PyQSO depends on the following Debian packages:
* gir1.2-gtk-3.0
* python3
* python3-gi-cairo (for log printing purposes)
The following extra packages are necessary to enable the grey line tool and the plotting of logbook statistics:
* python3-matplotlib (version 1.3.0 or later)
* python3-mpltoolkits.basemap
* python3-numpy
* libxcb-render0-dev
* python3-cairocffi
The following extra package is necessary to build the documentation:
* python3-sphinx
There currently does not exist a Python 3-compatible Debian package for [Hamlib](http://www.hamlib.org). This library must be built manually to enable Hamlib support.
Contact
-------
If you have any comments or questions about PyQSO, please send them via email to Christian Jacobs (2E0ICL) at <christian@christianjacobs.uk>.
|