Skip to content

Commit

Permalink
Preparing README.md for CI, Doxygen build deployed to Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrptdev2 committed Sep 30, 2024
1 parent 863edf7 commit ca46060
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
[![pages-build-deployment](https://github.com/subreption/hackrf_sweeper/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/subreption/hackrf_sweeper/actions/workflows/pages/pages-build-deployment)

[![Doxygen Documentation](https://github.com/subreption/hackrf_sweeper/actions/workflows/deploy_doxygen.yml/badge.svg)](https://github.com/subreption/hackrf_sweeper/actions/workflows/deploy_doxygen.yml)

# HackRF Sweeper

> **A reimplementation of hackrf_sweep as a library: TSCM for Joe the plumber**
Expand Down Expand Up @@ -36,7 +40,12 @@ We intend to design and develop a GNU Radio block related to this library.

## Documentation

Pending deployment of CI with Github to generate and host HTML versions of the documentation, it can be generated like so:
The documentation is automatically published upon changes to this repository at:

https://subreption.github.io/hackrf_sweeper/

### Generating locally
The documentation can be generated like so:

```
$ cd docs/doxygen
Expand Down

0 comments on commit ca46060

Please sign in to comment.