Create README.md

README.md

@@ -1 +1,38 @@
-# ManaTTS-Persian-Speech-Dataset
+# ManaTTS-Persian-Speech-Dataset
+
+ManaTTS is the largest publicly accessible single-speaker Persian corpus, comprising approximately 86 hours of audio with a sampling rate of 44.1 kHz. It is released under the open CC-0 license, enabling educational and commercial use. This dataset is a comprehensive speech dataset for the Persian language, collected from the [Nasl-e-Mana](https://naslemana.com/) magazine. It includes a wide range of topics and domains, making it suitable for training high-quality text-to-speech models. The dataset is accompanied by a fully transparent, open-source pipeline for data collection and processing, including tools for sentence tokenization, audio segmentation, and forced alignment.
+
+## Dataset
+The ManaTTS dataset can be downloaded from [this link](link to be updated).
+
+## Raw Data Crawling
+The raw data for this dataset was crawled from the Nasl-e-Mana magazine website. The crawling script used for this purpose is also provided in this repository.
+
+## Processing Pipeline
+The following figure illustrates the overall processing pipeline used to create the ManaTTS dataset, including the steps for preprocessing, alignment, and post-processing.
+
+<p align="center">
+  <img src="https://github.com/MahtaFetrat/ManaTTS-Persian-Speech-Dataset/assets/62302965/ebb75e4b-4c44-4b15-9554-df9401dd0e72" width="800">
+</p>
+
+This pipeline is available as a Jupyter Notebook included in this repository.  You can also run the notebook on Google Colab using [this link](https://colab.research.google.com/drive/1fWTy4IH2tSuOLrLSD8E8LMaUlI_Gnf-e?usp=sharing).
+
+To run the pipeline, follow these steps:
+
+1. Set up the required environment (details in the notebook)
+2. Place the raw audio and text files in a directory named `raw`
+3. Execute the cells in the notebook sequentially
+
+## Trained TTS Model
+A text-to-speech (TTS) model has been trained on the ManaTTS dataset. The code for training the model, as well as some output samples, are available in [this repository](https://github.com/MahtaFetrat/Persian-MultiSpeaker-Tacotron2).
+
+## Contributing
+Contributions to this project are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.
+
+## License
+The ManaTTS dataset is released under the CC-0 1.0 license, while the processing pipeline is licensed under the MIT license.
+
+## Citation
+If you use this dataset or the processing pipeline in your work, please cite the following paper:
+
+(citation to be updated)