Skip to content

Commit 985d185

Browse files
author
Dennis Mantz
committed
Improving manual and readme
1 parent e75c712 commit 985d185

File tree

8 files changed

+32
-15
lines changed

8 files changed

+32
-15
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ jobs:
2626
restore-keys: |
2727
mkdocs-material-
2828
- run: pip install mkdocs-material pymdown-extensions
29-
- run: mkdocs gh-deploy --force
29+
- run: mkdocs gh-deploy --no-directory-urls --force

Readme.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Whether you're a radio hobbyist, ham operator, or just curious about what's
99
flying through the airwaves, RF Analyzer makes exploring the RF world from your
1010
phone both practical and fun.
1111

12-
![RF Analyzer Screenshot](todo)
12+
![RF Analyzer Screenshot](./resources/graphics/appstore/feature_graphic.png)
1313

1414
---
1515

@@ -41,7 +41,7 @@ phone both practical and fun.
4141

4242
A full **user manual** is available in the `docs/` folder and online via MkDocs:
4343

44-
[**Read the RF Analyzer Manual**](todo)
44+
[**Read the RF Analyzer Manual**](https://demantz.github.io/RFAnalyzer/)
4545

4646
Topics include:
4747

@@ -59,7 +59,7 @@ Topics include:
5959

6060
Get RF Analyzer on **Google Play**:
6161

62-
[![Get it on Google Play](docs/assets/google-play-badge.png)](https://play.google.com/store/apps/details?id=com.mantz_it.rfanalyzer)
62+
[![Get it on Google Play](./docs/assets/google_play_badge.png)](https://play.google.com/store/apps/details?id=com.mantz_it.rfanalyzer)
6363

6464
The app is available as a **free trial**, giving you 7 days of usage after
6565
installation and up to 60 minutes of operation time. This allows you to fully
@@ -82,9 +82,8 @@ Hello, my name is Dennis Mantz and I greet you from Heidelberg in Germany! How
8282
to reach me:
8383

8484
- Callsign: DM4NTZ
85-
- Mastodon: @dm4ntz@chaos.social
86-
- Blog: http://tech.mantz-it.com
87-
- Mail: rfanalyzerapp -at- gmail.com
85+
- Mastodon: [@dm4ntz@chaos.social](https://chaos.social/@dm4ntz)
86+
- Mail: rfanalyzerapp -at- gmail -dot- com
8887

8988
## License
9089

417 KB
Loading

docs/assets/rtlsdr_source_tab.png

617 KB
Loading
794 KB
Loading

docs/index.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,36 @@
11
# RF Analyzer 2.0 User Manual
22

3-
Welcome to the **RF Analyzer 2.0** user manual. This guide will help you to
4-
install, configure, and effectively use the app for spectrum analysis and
5-
signal demodulation.
3+
<div style="display: flex; align-items: center; flex-wrap: wrap;">
4+
<div style="flex: 1; min-width: 250px;">
5+
<p>
6+
Welcome to the <b>RF Analyzer 2.0</b> user manual. This guide will help you to
7+
install, configure, and effectively use the app for spectrum analysis and
8+
signal demodulation.
9+
</p>
10+
</div>
11+
<div style="flex-shrink: 0; margin-left: 20px; margin-top: 10px;">
12+
<a href="https://play.google.com/store/apps/details?id=com.mantz_it.rfanalyzer">
13+
<img src="./assets/google_play_badge.png" style="max-width: 100%; height: auto; width: 200px;" alt="Get it on Google Play">
14+
</a>
15+
</div>
16+
</div>
617

718
## Features
819
- Real-time FFT & waterfall spectrum visualization
920
- Support for **HackRF, RTL-SDR, and IQ file playback**
1021
- Adjustable SDR settings (frequency, gain, sample rate, etc.)
1122
- Analog signal demodulation (CW, AM, nFM, wFM, LSB, USB)
1223

24+
<p float="left">
25+
<img src="./assets/rtlsdr_source_tab.png" width="45%" />
26+
<img src="./assets/rtlsdr_demodulation_tab_fm.png" width="45%" />
27+
</p>
28+
1329
### New in RF Analyzer 2.0
1430
- Complete rework of the app in a modern language (Kotlin) and with a modern Material Design based UI
1531
- Demodulation can run as **background service** without a foreground app
1632
- Significant performance improvements
33+
- Built-in context-aware help and a full offline in-app manual
1734

1835
---
1936

docs/setup.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ section [SDR Source](./sdr-source.md).
1010

1111
The app can be downloaded via the Google Play Store. Use the following link:
1212

13-
[<img src="/assets/google_play_badge.png" alt="RF Analyzer on Google Play" width="200px">](https://play.google.com/store/apps/details?id=com.mantz_it.rfanalyzer)
13+
[https://play.google.com/store/apps/details?id=com.mantz_it.rfanalyzer](https://play.google.com/store/apps/details?id=com.mantz_it.rfanalyzer)
14+
15+
<a href="https://play.google.com/store/apps/details?id=com.mantz_it.rfanalyzer"><p align="center"><img src="./assets/google_play_badge.png" alt="RF Analyzer on Google Play" width="200px"></p></a>
16+
1417

1518
You can try all features for free with a 7-day trial and up to 60 minutes of
1619
analyzer usage.
@@ -43,7 +46,7 @@ using a [USB OTG adapter](https://en.wikipedia.org/wiki/USB_On-The-Go). You
4346
might have received such an adapter with your phone as it is usually used to
4447
transfer data from you old phone to the new one.
4548

46-
!!! warning "TODO: add image of OTG adapter and connected sdr"
49+
![](./assets/tutorial_connect_sdr.png)
4750

4851
When connecting the SDR, the RTL-SDR driver app immediatly shows a dialog
4952
requesting permissions to the device.
@@ -68,9 +71,7 @@ Select **RTL-SDR** in the source tab dropdown menu in the RF Analyzer app.
6871
Before starting the analyzer, scroll down and enable **External Server**.
6972
Enter the IP address and port:
7073

71-
!!! warning "TODO: screenshot"
72-
73-
Afterwards, start the analyzer by pressing the **Play** Button ().
74+
Afterwards, start the analyzer by pressing the **Play** Button.
7475

7576
!!! warning "Firewall might block access to the server"
7677
If your host computer is behind a firewall or has a local firewall
456 KB
Loading

0 commit comments

Comments
 (0)