Updated Home (markdown)

master
Edouard Griffiths 2022-01-05 11:13:25 +01:00
rodzic 37e8f23b3b
commit f833605648
1 zmienionych plików z 17 dodań i 8 usunięć

25
Home.md

@ -4,7 +4,7 @@
This software project is committed to Open Source that is you as a visitor, collaborator, simple user... will always be guaranteed access to the source code. You may fork this repository, change the code, take bits to use in another project or just run it. It is important to realize that source code is THE value of this software. Artifacts are considered as accessory. This is NOT free software as in free lunch and when you run it a collaborative attitude is expected.
This software is provided in the hope it will be useful. Its main goal is to provide a Software Defined Radio platform that is is committed to:
This software is provided in the hope it will be useful. Its main goal is to provide a Software Defined Radio platform that is committed to:
- 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
@ -22,7 +22,7 @@ Therefore I ask you (as a User or Collaborator) to take the role of first level
<h3>Reporting run time issues</h3>
An SDR application is complex having close interaction with hardware devices most often connected via USB and running in real time. Many things can happen that are related to your environment and the purpose is to extract what is relevant to the software itself. You may also consider an issue what is just a limitation. You must describe the conditions and scenario that leads to what you consider an issue the best possible so it can be reproduced in the Maintainer's reference environment.
A SDR application is complex having close interaction with hardware devices most often connected via USB and running in real time. Many things can happen that are related to your environment and the purpose is to extract what is relevant to the software itself. You may also consider an issue what is just a limitation. You must describe the conditions and scenario that leads to what you consider an issue the best possible so it can be reproduced in the Maintainer's reference environment.
<h3>Reference environments</h3>
@ -37,15 +37,24 @@ You will find `flatpak` and `snap` folders in the source tree. They have been co
<h2>Continuous Integration and Delivery</h2>
At present this is done using [Appveyor](https://www.appveyor.com/) and is driven by the [.appveyor.yml](https://github.com/f4exb/sdrangel/blob/master/.appveyor.yml) file. The first two builds are run at Appveyor premises on virtual machines which profile may be found here:
- [Linux](https://www.appveyor.com/docs/linux-images-software/) Ubuntu 20.04 from v4.14.10
- [Windows](https://www.appveyor.com/docs/windows-images-software/) with Visual Studio 2019
- A Docker image build using [this Dockerfile](https://github.com/f4exb/sdrangel-docker/blob/master/sdrangel/Dockerfile) is run at the owner premises.
For every release on master branch the resulting artifacts are uploaded to the [releases section](https://github.com/f4exb/sdrangel/releases).
<h3>Linux and Docker</h3>
This is done using [Appveyor](https://www.appveyor.com/) and is driven by the [.appveyor.yml](https://github.com/f4exb/sdrangel/blob/master/.appveyor.yml) file. The builds are run at the owner premises.
The Linux build yields a .deb file and is done in a docker container based on a Ubuntu 20.04 image provided by Appveyor. The Qt version in use is 5.12.8.
The Docker image is built using [this Dockerfile](https://github.com/f4exb/sdrangel-docker/blob/master/sdrangel/Dockerfile).
You can check [SDRangel project](https://ci.appveyor.com/project/f4exb/sdrangel) in Appveyor where all builds and artifacts may be consulted.
<h3>Windows</h3>
This is done via the Actions Github feature and based on [this file](https://github.com/f4exb/sdrangel/blob/master/.github/workflows/sdrangel.yml) The build is based on MSVC 2019 and Qt 5.15.2
You can check [this section](https://github.com/f4exb/sdrangel/actions/workflows/sdrangel.yml) for the latest builds.
<h2>Repository branches</h2>
- master: this is the default branch and is the most up to date that will eventually make the next release. This is the branch used to produce release artifacts.