diff options
| author | drowe67 <[email protected]> | 2024-05-06 06:14:02 +0930 |
|---|---|---|
| committer | David Rowe <[email protected]> | 2024-05-06 06:14:02 +0930 |
| commit | f004b51451fe78b8f289c8a553acad06f2768d9e (patch) | |
| tree | 36988dca4a65d86e0ca8a1308cb42b2ed7b2ab30 /README.md | |
| parent | b2311e5a967e09e5b293578bb596c83c50af536d (diff) | |
| parent | d21ff74c5f830a275d291a00043b2526a1bf9e62 (diff) | |
Merge branch 'main' into dr-freedata-001dr-freedata-001
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 5 insertions, 3 deletions
@@ -25,7 +25,7 @@ The code supporting these modes won't be going away any time soon (and we will c We have a process for considering Feature Requests and Pull Requests that we will guide you through. -Feature Requests can be submitted via GitHub Issues. +If you have a Feature Request, please answer the questions in the [Feature Request Form](https://freedv.org/wp-content/uploads/sites/8/2024/03/FreeDV-027-Feature-Request-Form-V1.1.pdf), and submit your answers as a GitHub Issue. Before writing any code or submitting a PR - **please discuss** the PR with developers by raising a GitHub Issue. We have many years of experience and a carefully considered plan for Codec 2 development, and can guide you on work that will most benefit this project. @@ -36,7 +36,9 @@ Some key guidelines about the code in the `codec2` repo: ## Ports to non C99 Compilers -We have standardized on C99 and develop and test using gcc on a Linux platform. We encourage people who want to use non-standard compilers like MSVC and certain embedded compilers to maintain their own Codec 2 forks. Our focus needs to be on what’s unique about our project – the speech codec and modem waveforms – rather than consuming time and resources on non-core activities that others can do equally well. If you decide to fork Codec 2 to a non C99 compiler - please ensure you port the ctests and that they all pass. If the tests have not been ported or do not pass - it's not Codec 2. +For Windows applications (built with MSVC or any compiler) we recommend linking with our [cross-compiled](#building-for-windows) Codec 2 DLLs. This lets you enjoy the benefits of our carefully developed, tested and maintained codebase without having to develop and maintain your own fork. + +We have standardized on C99 and develop and test using gcc on a Linux platform. Our focus needs to be on what’s unique about our project – the speech codec and modem waveforms, and we lack the resources to support multiple compilers. If you want to build Codec 2 using a non-standard compiler like MSVC and certain embedded compilers you will need to maintain your own Codec 2 fork (a very large commitment). If you decide to fork Codec 2 to a non C99 compiler - please ensure you port the ctests and that they all pass. If the tests have not been ported or do not pass - it's not Codec 2. ## Quickstart @@ -203,7 +205,7 @@ wav - speech files in wave file format make ``` -## Bulding for Windows +## Building for Windows We develop and test on Linux to the [C99 standard](#ports-to-non-c99-compilers). We recommend using MinGW to cross compile for Windows. |
