From 2f5627c45c3697e412b38ec0e360825eca1a01d2 Mon Sep 17 00:00:00 2001 From: Achilles Kappis <axilleaz@protonmail.com> Date: Tue, 26 Mar 2024 13:31:14 +0000 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5b3da0f..57af50b 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,25 @@ This repository holds the open-access codebase used within the [IN-NOVA](https:/ The codebase under each section may or may not include code implementations in different languages but no plan exists to port each implementation in all available programming languages. More information about the codebase, the available implementations and topics/fields can be found in the [Documentation]() of the project and its [Wiki](https://gitlab.com/in-nova/in-nova/-/wikis/home). +## Current structure + +The current structure of the codebase is shown below. More information can be found in the [Wiki]() with separate pages for each category, and implementation. + +- [Templates](https://gitlab.com/in-nova/in-nova/-/tree/main/Templates?ref_type=heads) + - Function templates +- [Utilities](https://gitlab.com/in-nova/in-nova/-/tree/main/Utilities?ref_type=heads) +- [Active Noise Control](https://gitlab.com/in-nova/in-nova/-/tree/main/Active%20Noise%20Control) + - Optimal tonal control + - Frequency domain +- [Virtual Sensing](https://gitlab.com/in-nova/in-nova/-/tree/main/Virtual%20Sensing) + - Remote Microphone Technique +- [Optimisation](https://gitlab.com/in-nova/in-nova/-/tree/main/Optimisation/Memetic%20Algorithm) + - Memetic Algorithm +- [Signal Processing](https://gitlab.com/in-nova/in-nova/-/tree/main/Signal%20Processing) + - Array Processing + - Generic +- [Sound fields](https://gitlab.com/in-nova/in-nova/-/tree/main/Sound%20Fields) + - Generation ## Dependencies Effort has been put towards minimising dependencies external to this repository. Even "inter-repository" dependencies (ex. a function under some field uses a general utility function) will be clearly stated in the relevant code documentation. @@ -46,7 +65,7 @@ None. ## License -The project is licensed under the ***MIT License***, which is a rather unrestrictive license, effectively passing the code to the public scope. For more information see the [MIT License](https://mit-license.org/), or the [LICENSE](https://gitlab.com/in-nova/virtual-sensing/remote-microphone-technique/-/blob/main/LICENSE) file of the project. +The project is licensed under the ***MIT License***, which is a rather unrestrictive license, effectively passing the code to the public scope. For more information see the [MIT License](https://mit-license.org/), or the [LICENSE](https://gitlab.com/in-nova/in-nova/-/blob/main/LICENSE) file of the project. -- GitLab