From 0715f3dfc8e53646b30c50fda64990dd1fabe6e2 Mon Sep 17 00:00:00 2001
From: Sting <loic.allegre@ensiie.fr>
Date: Tue, 25 Jul 2023 21:23:37 +0200
Subject: [PATCH] Update README

---
 README.md | 76 +++++++++++++++++++++++++------------------------------
 1 file changed, 35 insertions(+), 41 deletions(-)

diff --git a/README.md b/README.md
index 793b0e5..6adaf81 100644
--- a/README.md
+++ b/README.md
@@ -1,45 +1,6 @@
 # AutoKara
 
-Experiment in automatic karaoke timing.
-
-# Some documentation first
-
-Having a clean python environment:
-
-- https://realpython.com/python-virtual-environments-a-primer/
-
-An introduction to neural networks and deep learning:
-
-- http://neuralnetworksanddeeplearning.com
-
-
-## Extracting vocals from music
-
-- https://github.com/facebookresearch/demucs
-
-## Syllable segmentation
-
-### Symbolic methods
-
- - [Syllable segmentation](https://www.sciencedirect.com/science/article/pii/S1877050916319068/pdf?md5=abc426e84a71cd4f5c0e6bef9713643e&pid=1-s2.0-S1877050916319068-main.pdf&_valck=1)
- - [Syllable segmentation and recognition](https://cdn.intechopen.com/pdfs/15947/InTech-Syllable_based_speech_recognition.pdf)
- - [Onset detection with librosa](https://librosa.org/doc/latest/onset.html)
-
-### Machine Learning & Deep Learning methods
-
-[Using CNNs on spectrogram images](https://www.ofai.at/~jan.schlueter/pubs/2014_icassp.pdf) (Schlüter, Böck, 2014) :
- - [MADMOM implementation](https://madmom.readthedocs.io/en/v0.16/modules/features/onsets.html)
-
-[Aligning lyrics to song](https://github.com/jhuang448/LyricsAlignment-MTL) (Jiawen Huang, Emmanouil Benetos, Sebastian Ewert, 2022)
-
-### Other methods
-
-Other stuff goes here
-
-## Syllable recognition
-
-If we ever want to use an AI to identify syllables without a reference lyrics file 
-
+An experiment in automatic karaoke timing.
 
 # Installation
 
@@ -49,7 +10,7 @@ If we ever want to use an AI to identify syllables without a reference lyrics fi
 - FFmpeg
 - Python >= 3.8
 
-All other python modules can be installed directly through pip, see further.
+All other python modules can be installed directly through PIP, see next section.
 
 ## Install
 
@@ -86,7 +47,9 @@ Having a CUDA-capable GPU is optional, but can greatly reduce processing time in
 ## Configuration
 
 Autokara comes with a default config file in `autokara/default.conf`.
+
 If you want to tweak some values (enable CUDA, for example), you should add them to a new config file in your personal config directory : `~/.config/autokara/autokara.conf`.
+
 This new file has priority over the default one, which is used only as fallback for unspecified values.
 
 
@@ -158,4 +121,35 @@ $ autokara-plot vocals.wav lyrics.ass
 ```
 
 
+# Documentation and useful links
+
+This section is mainly intended for people who would like to contribute and/or are curious about how this stuff works
+
+## Extracting vocals from music
+
+- https://github.com/facebookresearch/demucs
+
+## Syllable segmentation
+
+### Symbolic methods
+
+ - [Syllable segmentation](https://www.sciencedirect.com/science/article/pii/S1877050916319068/pdf?md5=abc426e84a71cd4f5c0e6bef9713643e&pid=1-s2.0-S1877050916319068-main.pdf&_valck=1)
+ - [Syllable segmentation and recognition](https://cdn.intechopen.com/pdfs/15947/InTech-Syllable_based_speech_recognition.pdf)
+ - [Onset detection with librosa](https://librosa.org/doc/latest/onset.html)
+
+### Machine Learning & Deep Learning methods
+
+[Using CNNs on spectrogram images](https://www.ofai.at/~jan.schlueter/pubs/2014_icassp.pdf) (Schlüter, Böck, 2014) :
+ - [MADMOM implementation](https://madmom.readthedocs.io/en/v0.16/modules/features/onsets.html)
+
+[Aligning lyrics to song](https://github.com/jhuang448/LyricsAlignment-MTL) (Jiawen Huang, Emmanouil Benetos, Sebastian Ewert, 2022)
+
+### Other methods
+
+Other stuff goes here
+
+## Syllable recognition
+
+If we ever want to use an AI to identify syllables without a reference lyrics file.
+
 
-- 
GitLab