Timed commands and clocks phase synchronization

.readthedocs.yaml

@@ -13,7 +13,7 @@ build:
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
-   configuration: docs/source/conf.py
+   configuration: docs_htime/source/conf.py
 
 # Build PDF for docs
 formats:

Readme.md

@@ -1,38 +1,30 @@
-# HackRF
+# HTime
 
-This repository contains hardware designs and software for HackRF,
-a low cost, open source Software Defined Radio platform.
+HTime is a firmware extension for the HackRF One, the open-hardware/open-source
+SDR by [Great Scott Gadgets](https://www.greatscottgadgets.com/hackrf/one/).
+HTime provides the HackRF SDR with the
+capability to perform timed commands and a precise phase synchronization
+of internal clocks (sampling, MCU, output) for the best timing performance.
 
-![HackRF One](https://raw.github.com/mossmann/hackrf/master/docs/images/HackRF-One-fd0-0009.jpeg)
+## Features
 
-(photo by fd0 from https://github.com/fd0/hackrf-one-pictures)
+* Unix-like time scale, with a resolution of 5 ns
+* RX/TX sampling synchronized with the time scale
+* Fine time scale/frequency adjust for synchronization with remote reference radio signals with a resolution of about 0.25 Hz @ 10 MHz
+* No external hardware required
+* Host time tool for access to time extension API
 
-principal author: Michael Ossmann <mike@ossmann.com>
+## Documentation
 
-Information on HackRF and purchasing HackRF: https://greatscottgadgets.com/hackrf/
+HTime documentation HTML pages are on
+[Read the Docs](https://htime.readthedocs.io/en/latest).
 
---------------------
+All other documentation about the HackRF can be found
+[here](https://hackrf.readthedocs.io/en/latest/).
 
-# Documentation
+## License
 
-Documentation for HackRF can be viewed on [Read the Docs](https://hackrf.readthedocs.io/en/latest/). The raw documentation files for HackRF are in the [docs folder](https://github.com/mossmann/hackrf/tree/master/docs) in this repository and can be built locally by installing [Sphinx Docs](https://www.sphinx-doc.org/en/master/usage/installation.html) and running `make html`. Documentation changes can be submitted through pull request and suggestions can be made as GitHub issues. 
+HTime © 2025 documentation by Fabrizio Pollastri is licensed under CC BY-SA 4.0 
 
-To create a PDF of the HackRF documentation from the HackRF repository while on Ubuntu:
-* run `sudo apt install latexmk texlive-latex-extra`
-* navigate to hackrf/docs on command line
-* run the command `make latex`
-* run the command `make latexpdf`
+HTime © 2025 software by Fabrizio Pollastri is licensed under GNU GPL v2.0
 
---------------------
-
-# Getting Help
-
-Before asking for help with HackRF, check to see if your question is listed in the [FAQ](https://hackrf.readthedocs.io/en/latest/faq.html).
-
-For assistance with HackRF general use or development, please look at the [issues on the GitHub project](https://github.com/greatscottgadgets/hackrf/issues). This is the preferred place to ask questions so that others may locate the answer to your question in the future.
-
-We invite you to join our community discussions on [Discord](https://discord.gg/rsfMw3rsU8). Note that while technical support requests are welcome here, we do not have support staff on duty at all times. Be sure to also submit an issue on GitHub if you've found a bug or if you want to ensure that your request will be tracked and not overlooked.
-
-If you wish to see past discussions and questions about HackRF, you may also view the [mailing list archives](https://pairlist9.pair.net/pipermail/hackrf-dev/).
-
-GitHub issues on this repository that are labelled "technical support" by Great Scott Gadgets employees can expect a response time of two weeks. We currently do not have expected response times for other GitHub issues or pull requests for this repository. 

docs_htime/.readthedocs.yaml

@@ -0,0 +1,24 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs_htime/source/conf.py
+
+# Build PDF for docs
+formats:
+  - pdf
+
+python:
+  install:
+    - requirements: docs/requirements.txt

docs_htime/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)