From ed3f0b9db3e72a7f11f1946595b4b70c94e6d6df Mon Sep 17 00:00:00 2001 From: Viginum-DataScientist-6 <210390336+Viginum-DataScientist-6@users.noreply.github.com> Date: Tue, 29 Jul 2025 15:47:01 +0000 Subject: [PATCH] feat(docs): switch to PyPI-based installation instructions Fixes #9. --- README.md | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 31c9a4b..74595d5 100644 --- a/README.md +++ b/README.md @@ -12,24 +12,11 @@ It distinguishes 3 types of duplicate contents : copypasta (almost exact duplica -## 💻 Installing - -Clone the repository +## 💻 Installation ```bash -git clone https://github.com/VIGINUM-FR/D3lta -``` - -Navigate to the project - -```bash -cd D3lta -``` - -Install the package - -```bash -pip install -e . +# PyPI is case insensitive, so d3lta == D3lta +pip install d3lta ``` ## 🚀 Quick start @@ -200,6 +187,26 @@ In the [`notebooks`](./notebooks/) directory, you can find: - [`example_synthetic_dataset.ipynb`](./notebooks/example_synthetic_dataset.ipynb): example of applying the D3lta methodology to the synthetic dataset, with a comparison to the true labels. +## 👩‍💻 Developing + +Clone the repository + +```bash +git clone https://github.com/VIGINUM-FR/D3lta +``` + +Navigate to the project + +```bash +cd D3lta +``` + +Install the package + +```bash +pip install -e . +``` + ## Citation If you find our paper and code useful in your research, please consider giving a star 🌟 and a citation 📝: