Updated Home (markdown)

master
f4exb 2020-02-29 18:55:49 +01:00
rodzic 27752e077f
commit 53a5ffdbe3
1 zmienionych plików z 15 dodań i 1 usunięć

16
Home.md

@ -6,4 +6,18 @@ This software is provided in the hope it will be useful. Its main goal is to pro
- be efficient: code should be written to be conservative on CPU resources it is not because the CPU power of machines constantly increase that this power should be wasted
- have fast paced instrumental graphics. Thanks to OpenGL spectrum, signal graphics and images can be rendered responsively
- give power to the user by letting him/her control all aspects of the DSP processing chain. But as you know with greater power comes greater responsibility therefore it is expected that you already have some experience with SDR applications and digital signal processing in general
- be an experimental platform for amateur radio or anyone interested in matters related to electromagnetism or communication based on electromagnetic waves. It is in no way intended for production moreover mission critical usage.
- be an experimental platform for amateur radio or anyone interested in matters related to electromagnetism or communication based on electromagnetic waves. It is in no way intended for production moreover mission critical usage.
<h2>Guidelines to report issues</h2>
As the principal author, owner and maintainer of this software I spend a good part of my free time working on this software, and I do it (mostly) for fun and learning new things. But one thing that I can tell you is no fun, is losing time hunting bugs that I cannot reproduce.
Therefore I would like to enforce the following guidelines.
<h3>Reporting compilation issues</h3>
[Compilation instructions](https://github.com/f4exb/sdrangel/wiki/Compile-from-source-in-Linux) are given in a particular reference context: Ubuntu 18.04 with prerequisites installed. It is very unlikely that problems occurring in this context will reach the master branch. However as this is source code I (as the Maintainer) cannot prevent you (as the User or Collaborator) from trying to compile it in a different context. However in this case you must show evidence that something is wrong in the code. Throwing out the compiler output is clearly not sufficient.
<h3>Reporting run time issues</h3>
I (as an Author and Maintainer) have more fun in developing new things, improving existing things or fixing defective things than hunting bugs. Therefore I ask you (as a User or Collaborator) to take the role of first level support. It means you have to help me and not the opposite: you have to help me understand the problem or what you think is a problem.