Merge pull request #120 from Guenael/doc

chore(doc): multiple minor fix

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,32 +1,27 @@
 ---
 name: Bug report
-about: Thank you for helping our community to improve this application
+about: ''
 title: ''
-labels: ''
+labels: 'bug'
 assignees: Guenael
-
 ---
 
-**Describe the bug**
+## Bug description
 A clear and concise description of what the bug is.
 
-**Setup & hardware used**
+## Setup & hardware used
-- Version of `rtlsdr-wsprd` & source (git pull or release archive)
+- Version of `rtlsdr-wsprd` & source used (git pull or release archive for example)
 - Version of `librtlsdr` intalled (with `ls -la /usr/lib/arm-linux-gnueabihf/librtlsdr.so.0`)
 - Computer hardware (ex. RaspberryPi 3, Laptop with Intel processor, etc...)
-- OS/Distro version (ex. `Raspbian GNU/Linux 10 (buster)`, or `cat /etc/os-release`)
+- OS/Distro version (ex. `Raspbian GNU/Linux 10 (buster)`, or use `cat /etc/os-release`)
 - Kernel used (with `uname -a`)
 - Reference of your RTLsdr dongle in use (& info reported by `rtlsdr-wsprd` at start)
 
-**Option used**
+## Options used
 Please provide the command line used with `rtlsdr-wsprd` and copy the first bloc that show the init. process.
 
-**Optional Samples**
+## Samples (optionnal)
-`rtlsdr-wsprd` allows to save samples with `-w <file prefix>` option, for debugging purpose.
+`rtlsdr-wsprd` allows to save samples with `-w <file prefix>` option, for debugging purpose. You can open these files with an editor like Audacity and use the spectrogram to inspect your signal. Zipping and adding these files could help to solve some issues.
-You can open these files with an editor like Audacity and use the spectrogram to inspect your transmission. Zipping and adding these files could help to solve some issues.
 
-**Additional context**
+## Additional context
 Add any other context about the problem here.
-
-Thanks!!
-Guenael

README.md

@@ -32,7 +32,7 @@ echo "== Install rtlsdr-wsprd"
 git clone https://github.com/Guenael/rtlsdr-wsprd
 cd rtlsdr-wsprd
 make
-make install
+sudo make install
 
 echo "== Start/test rtlsdr-wsprd"
 rtlsdr_wsprd -f 2m -c A1XYZ -l AB12cd -g 29
@@ -144,10 +144,10 @@ Some performance tests using:
 - rtlsdr-wsprd version 0.4.2
 - Build with `clang -O3 -std=gnu17`
 
-| Hardware  | Supported          | RX Load | Decode burst |
+| Hardware      | Supported          | RX Load | Decode burst |
-| --------- | ------------------ | ------- | ------------ |
+| ------------- | ------------------ | ------- | ------------ |
-| RPi-1     | :heavy_check_mark: | 23.2%   | 8.4s         |
+| RPi-1         | :heavy_check_mark: | 23.2%   | 8.4s         |
-| RPi-2     | :heavy_check_mark: | 13.5%   | 4.1s         |
+| RPi-2         | :heavy_check_mark: | 13.5%   | 4.1s         |
-| RPi-3     | :heavy_check_mark: | 10.9%   | 2.1s         |
+| RPi-3         | :heavy_check_mark: | 10.9%   | 2.1s         |
-| RPi-4     | :heavy_check_mark: |  5.8%   | 1.1s         |
+| RPi-4         | :heavy_check_mark: |  5.8%   | 1.1s         |
-| i7-5820K  | :heavy_check_mark: |  1.7%   | 0.5s         |
+| PC (i7-5820K) | :heavy_check_mark: |  1.7%   | 0.5s         |