diff --git a/README.coding.md b/README.coding.md index 40ea554..729eed4 100644 --- a/README.coding.md +++ b/README.coding.md @@ -27,3 +27,9 @@ No attempt is made to follow popular object-oriented practices. # Known limitations * The code is not intended to be thread-safe. + +* Ideally, signal processing software should always yield the same + output when presented with the same input. + leandvb should be deterministic on fast input streams (files). + However, on real-time streams, scheduling randomness can affect + internal feedback loops and cause small variations in the output. diff --git a/README.md b/README.md index a99c292..7770b9d 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,23 @@ leansdr: Lightweight, portable software-defined radio. + Copyright (C) 2016 -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see . - +> This program is free software: you can redistribute it and/or modify +> it under the terms of the GNU General Public License as published by +> the Free Software Foundation, either version 3 of the License, or +> (at your option) any later version. +> +> This program is distributed in the hope that it will be useful, +> but WITHOUT ANY WARRANTY; without even the implied warranty of +> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +> GNU General Public License for more details. +> +> You should have received a copy of the GNU General Public License +> along with this program. If not, see . **leansdr** consists of: * A simple data-flow framework for signal processing -* A library of software-defined radio functions +* A C++ library of software-defined radio functions * Applications built on top of the above. Currently the main application is **leandvb**. @@ -25,7 +25,9 @@ Currently the main application is **leandvb**. # leandvb **leandvb** is a DVB-S demodulator designed for speed rather -than sensitivity. See http://www.pabr.org/radio/leandvb . +than sensitivity. + +See http://www.pabr.org/radio/leandvb for details and use cases. ## Quick start guide