diff --git a/README.md b/README.md new file mode 100644 index 0000000..a37d0f8 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +libosmo-dsp - Osmocom DSP utility functions +=========================================== + +This repository contains a C-language library for common DSP (Digital +Signal Processing) primities for SDR (Software Defined Radio). +They are part of the [Osmocom](https://osmocom.org/) Open Source Mobile +Communications project. + +Homepage +-------- + +The official homepage of the project is +https://osmocom.org/projects/libosmo-dsp + +GIT Repository +-------------- + +You can clone from the official libosmo-dsp.git repository using + + git clone git://git.osmocom.org/libosmo-dsp.git + +There is a cgit interface at http://git.osmocom.org/libosmo-dsp/ + +Documentation +------------- + +Doxygen-generated API documentation is generated during the build +process, but also available online for each of the sub-libraries at + + +Mailing List +------------ + +Discussions related to libosmo-dsp are happening on the +osmocom-sdr@lists.osmocom.org mailing list, please see +https://lists.osmocom.org/mailman/listinfo/osmocom-sdr for subscription +options and the list archive. + +Please observe the [Osmocom Mailing List +Rules](https://osmocom.org/projects/cellular-infrastructure/wiki/Mailing_List_Rules) +when posting. + +Contributing +------------ + +Our coding standards are described at +https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards + +We are receiving patch submissions via e-mail to the above-mentioned +mailing list.