2013-10-04 14:18:52 +00:00
File: README.md
2013-10-04 14:16:57 +00:00
Copyright (C) 2013 Christian 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
2013-10-04 14:18:52 +00:00
along with PyQSO. If not, see < http: / / www . gnu . org / licenses / > .
2013-10-04 14:16:57 +00:00
2013-10-04 14:18:52 +00:00
PyQSO
2013-10-04 13:55:57 +00:00
=====
2013-10-04 18:32:14 +00:00
PyQSO is a contact logging tool for amateur radio operators.
2013-10-04 14:16:57 +00:00
2013-10-04 14:52:00 +00:00
Installation and running
------------------------
2013-10-04 14:16:57 +00:00
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`
2013-10-04 14:42:53 +00:00
Note: 'sudo' may be needed for this. Once installed, the following command will run PyQSO:
2013-10-04 14:16:57 +00:00
2013-10-04 16:06:26 +00:00
`pyqso`
2013-10-04 14:16:57 +00:00
2013-10-04 19:23:24 +00:00
Alternatively, PyQSO can be run (without installing) with:
2013-10-04 14:16:57 +00:00
`python bin/pyqso`
from PyQSO's base directory.
2013-10-04 14:52:00 +00:00
Documentation
-------------
2013-10-04 14:16:57 +00:00
The PyQSO user manual is stored as a LaTeX source file in the doc/ directory. It can be compiled with the following command:
`make manual`
which will produce the manual.pdf file.
Dependencies
------------
2013-10-04 18:32:14 +00:00
PyQSO depends on the following Debian packages:
2013-10-04 14:16:57 +00:00
* gir1.2-gtk-3.0
2013-10-04 17:31:55 +00:00
* python2.7
2014-02-18 12:15:33 +00:00
* python-gi-cairo (for log printing purposes)
2013-10-04 18:32:14 +00:00
The following extra packages are necessary to enable the grey line tool:
2013-10-04 14:16:57 +00:00
* python-mpltoolkits.basemap
* python-numpy
2013-10-04 15:07:07 +00:00
* python-matplotlib (version 1.3.0 or later)
2013-10-04 14:16:57 +00:00
2013-10-04 18:32:14 +00:00
The following extra package is necessary to enable Hamlib support:
* python-libhamlib2
