From b28b4ae34b2502433457007e7cc5120c62e80e23 Mon Sep 17 00:00:00 2001
From: Ludovic Moncla <ludovic.moncla@insa-lyon.fr>
Date: Fri, 4 Jun 2021 09:47:46 +0200
Subject: [PATCH] update readme

---
 .gitignore |  3 +++
 README.md  | 24 +++++++++++++++++++++++-
 2 files changed, 26 insertions(+), 1 deletion(-)
 create mode 100644 .gitignore

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..4cd4a41
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+
+.DS_Store
+data/EDdA_dataframe_withContent.tsv
diff --git a/README.md b/README.md
index 7286619..b518c4c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,24 @@
-# EDdA Classification
 
+This repository is proposed by **Khaled Chabane**, **Ludovic Moncla** and **Alice Brenon** as part of the GEODE project.
+
+
+# Install dependencies
+
+    pip3 install -r requirements.txt
+
+
+# Get Started
+
+To run the script for preparing data use the following command :
+
+    python tmp_preprocess_data.py 
+
+
+In order to run the classifiers, use the following command :
+
+    python experimentsClassicClassifiers.py <dataset_tsv_file> <content_column_name> <labels_column_name> <min_sample_per_class> <max_sample_per_class>
+
+
+# Acknowledgment
+
+The authors are grateful to the ASLAN project (ANR-10-LABX-0081) of the Université de Lyon, for its financial support within the French program "Investments for the Future" operated by the National Research Agency (ANR).
\ No newline at end of file
-- 
GitLab