From 29bbd85f149baf033cd870ff86ae00fcc9becbf5 Mon Sep 17 00:00:00 2001 From: Luchesar ILIEV Date: Mon, 30 Oct 2023 21:24:56 +0200 Subject: [PATCH] README: links to docs and examples --- README.md | 12 ++++++++---- README.pypi | 1 + 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 25114fbd..ddd18b22 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ +# ramanchada2 + [![build](https://github.com/h2020charisma/ramanchada2/workflows/build/badge.svg)](https://github.com/h2020charisma/ramanchada2/actions/workflows/build.yml) [![docs](https://github.com/h2020charisma/ramanchada2/workflows/docs/badge.svg)](https://h2020charisma.github.io/ramanchada2/index.html) -Harmonising Raman Spectroscopy -============================== +Harmonising Raman spectroscopy: meant to fill the gap between the theoretical Raman analysis and the experimental Raman spectroscopy by providing means to compare data of different origin. + +- 📖 [Documentation](https://h2020charisma.github.io/ramanchada2/ramanchada2.html) +- ⚗️ [Examples](https://github.com/h2020charisma/ramanchada2/tree/main/examples) + -RamanChada v2 --------------- +## Quick start Clone the repo using https ```bash diff --git a/README.pypi b/README.pypi index 16e8bac1..7d506eea 100644 --- a/README.pypi +++ b/README.pypi @@ -5,6 +5,7 @@ ramanchada2 is meant to fill the gap between the theoretical Raman analysis and For more information, see: * https://github.com/h2020charisma/ramanchada2 * https://h2020charisma.github.io/ramanchada2/ramanchada2.html +* https://github.com/h2020charisma/ramanchada2/tree/main/examples --- 🇪🇺 This project has received funding from the European Union’s Horizon 2020 research and innovation program under [grant agreement No. 952921](https://cordis.europa.eu/project/id/952921).