From 51798fbc816855dbc1c1b994c677cfe1f0f4d22e Mon Sep 17 00:00:00 2001 From: Ian Renton Date: Fri, 18 Sep 2026 17:10:30 +0100 Subject: [PATCH] Doc updates --- README.md | 33 +++++++++++---------------------- templates/about.html | 8 +++++++- 2 files changed, 18 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 84915cc..53f04eb 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open JSON API as well as a website to browse the data, and its own telnet server for integration with desktop loggers. +A "main" or example server runs at [https://spothole.app](https://spothole.app/) in case you'd like to try it out. + ![Screenshot](/images/screenshot.png) While there are several other web-based interfaces to DX clusters, and sites that aggregate spots from various outdoor @@ -20,6 +22,8 @@ SOTA, WWFF, GMA, WWBOTA, HEMA, Parks 'n' Peaks, ZLOTA, WOTA, BOTA, LLOTA, WWTOTA Repeater Network, NG3K, and any site based on the xOTA software by nischu. It also integrates with QRZ.com and HamQTH, retrieves solar data from various sources, provides information about upcoming contests, and more. +You can read more about Spothole on [the "About" page of the main server instance](https://spothole.app/about). + ![Screenshot](/images/screenshot2.png) ![Screenshot](/images/screenshot3.png) @@ -48,7 +52,9 @@ Spothole server, or to modify it in any way. More details can be found in the fo ## Thanks -As well as being my work, I have also gratefully received feature patches from Steven, M1SDH. +[Spothole's "About" page](https://spothole.app/about) contains the full details of the thanks I owe to the various +programme teams, software library providers, bug fixers etc. The extra detail below contains the extra detail of +specific files in this repository which are not all my own work and may be subject to other licences. The project contains GeoJSON files for CQ and ITU zones, in the `/datafiles/` directory. These are MIT-licenced and, to my knowledge, created by HA8TKS for his CQ and ITU zone layers for Leaflet. `/datafiles` also contains a @@ -60,26 +66,9 @@ conference centres. The project contains a set of flag icons generated using the "Noto Color Emoji" font on a Debian system, in the `/static/img/flags/` directory. -The software uses a number of Python libraries as listed in `requirements.txt`, and a number of JavaScript libraries. -This project would not have been possible without these libraries, so many thanks to their developers. - -### Third Party Libraries - -A number of third-party libraries are self-hosted in the `/static/vendor/` directory. These files are subject to their -own licences and are not covered by the overall licence declared in the `LICENSE` file. - -A number of third-party libraries are self-hosted in the `/webassets/vendor/` directory. These files are subject to -their own licences and are not covered by the overall licence declared in the `LICENSE` file. +The software uses a number of Python libraries as listed in `requirements.txt`, and a number of JavaScript libraries +which are self-hosted in the `/static/vendor/` directory. This project would not have been possible without these +libraries, so many thanks to their developers. These libraries are subject to their own licences and are not covered by +the overall licence declared in Spothole's `LICENSE` file. Sound effects are CC0-licenced and sourced from [Pixabay](https://pixabay.com). - -Particular thanks go to country-files.com for providing country lookup data for amateur radio, to K0SWE -for [this JSON-formatted DXCC data](https://github.com/k0swe/dxcc-json/), and to the developers of `pyhamtools` for -making it easy to use country-files.com data as well as QRZ.com and Clublog lookup. - -Amateur radio clusters, outdoor programmes, propagation data providers etc. are almost all volunteer-run services that -make no or little profit, and are done for the love of amateur radio. Services like Spothole, which build on top of -them, are truly standing on the shoulders of giants. None of this would have been possible without the hard work and -dedication of many other people within the amaetur radio community. - -The project's name was suggested by Harm, DK4HAA. Thanks! diff --git a/templates/about.html b/templates/about.html index 45e562a..06a6d06 100644 --- a/templates/about.html +++ b/templates/about.html @@ -217,9 +217,15 @@ modelling software, and other online tools on which Spothole's data is based. The vast majority of these are not profit-seeking and are made purely for the love of the hobby and to help others in the community. Spothole is standing on the shoulders of giants, who deserve a huge amount of thanks for all the work they put in.

-

Spothole is also dependent on a number of Python libraries, in particular pyhamtools, and many JavaScript +

The following people have specifically helped develop Spothole either by contributing code, requesting features, + or helping squash bugs: Steven M1SDH, Dan S50U, Matt W1CDN, Norby LX1NO, Andrew VK3ARR, Mario DL4MFM, Mark M5TEA, + Michael G7VJR, Rob G7LAS, Ed DD5LP, Raph F4LUB, Luc ON7KEC, Richard GD4OFB, Daniel PY2TDB, Alan VK1AO, + Andrew WK1AD, Ullrich DF5WC, Wayne N3CDF, Jonathan G4IVV, Erik N2EPE, Sorin YO9TSN, Matt HB9HWI, Priit ES1TEB, + Leigh KG7WED, Jouni OH3CUF, Onno VK6FLAB, and Bruce WA7BNM. (If I've forgotten you, let me know!)

+

Spothole is also dependent on a number of Python libraries, such as pyhamtools, and many JavaScript libraries, as well as the Font Awesome icon set and flag icons from the Noto Color Emoji set, and MIT-licenced GeoJSON files for CQ and ITU zones from HA8TKS.

+

The project's name was suggested by Harm DK4HAA.

This software is dedicated to the memory of Tom G1PJB, SK, a friend and colleague who sadly passed away around the time I started writing it in Autumn 2025. I was looking forward to showing it to you when it was done.