Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed Jul 10, 2022
1 parent dbe315a commit 7f3dc39
Show file tree
Hide file tree
Showing 3 changed files with 151 additions and 168 deletions.
42 changes: 0 additions & 42 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -617,45 +617,3 @@ Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>

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

This program 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 Affero General Public License for more details.

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

Also add information on how to contact you by electronic and paper mail.

If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.

You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<http://www.gnu.org/licenses/>.
49 changes: 24 additions & 25 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
.. image:: https://img.shields.io/badge/Python-3.6,%203.7-green.svg
.. image:: https://github.com/earthobservations/luftdatenpumpe/workflows/Tests/badge.svg
:target: https://github.com/earthobservations/luftdatenpumpe/actions?workflow=Tests

.. image:: https://img.shields.io/pypi/pyversions/luftdatenpumpe.svg
:target: https://pypi.org/project/luftdatenpumpe/

.. image:: https://img.shields.io/pypi/status/luftdatenpumpe.svg
:target: https://pypi.org/project/luftdatenpumpe/

.. image:: https://img.shields.io/pypi/v/luftdatenpumpe.svg
:target: https://pypi.org/project/luftdatenpumpe/

.. image:: https://img.shields.io/github/tag/earthobservations/luftdatenpumpe.svg
:target: https://github.com/earthobservations/luftdatenpumpe
.. image:: https://pepy.tech/badge/luftdatenpumpe/month
:target: https://pypi.org/project/luftdatenpumpe/

.. image:: https://img.shields.io/pypi/l/luftdatenpumpe.svg
:target: https://github.com/earthobservations/luftdatenpumpe/blob/main/LICENSE

|
##############
Luftdatenpumpe
##############

.. image:: https://assets.okfn.org/images/ok_buttons/od_80x15_red_green.png
:target: https://okfn.org/opendata/
Expand All @@ -16,16 +31,11 @@
.. image:: https://assets.okfn.org/images/ok_buttons/os_80x15_orange_grey.png
:target: https://okfn.org/opendata/

|
##############
Luftdatenpumpe
##############


*****
About
*****

Process live and historical data from `luftdaten.info`_, irceline_ and OpenAQ_.
Filter by station-id, sensor-id and sensor-type, apply reverse geocoding,
store into TSDB_ and RDBMS_ databases (InfluxDB_ and PostGIS_),
Expand Down Expand Up @@ -100,6 +110,7 @@ or visit `luftdatenpumpe --help`_.
***********
Screenshots
***********

Luftdaten-Viewer displays stations and measurements from luftdaten.info (LDI) in Grafana.


Expand Down Expand Up @@ -127,8 +138,8 @@ Map popup labels
************
Installation
************
If you are running Python 3 already,
installing the program should be as easy as::

If you are running Python 3 already, installing the program should be as easy as::

pip install luftdatenpumpe

Expand Down Expand Up @@ -168,26 +179,14 @@ panel-widgets like outlined in the "Testimonials" section.
*******
License
*******
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.

This program 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 Affero General Public License
along with this program; if not, see:
<https://www.gnu.org/licenses/agpl-3.0.txt>,
or write to the Free Software Foundation,
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
This project is licensed under the terms of the AGPL license.


********************
Content attributions
********************

The copyright of particular images and pictograms are held by their respective owners, unless otherwise noted.

Icons and pictograms
Expand Down
Loading

0 comments on commit 7f3dc39

Please sign in to comment.