Edit README

wikipedia_to_canoprof/README.md

-Liste des fonctions du convertisseur wikipedia_to_canoprof
-
-
-
-Une activité est composée de : 
-- Entete : 
-    titre 
-    Durée => Ne peut pas être renseignée à partir de wiki 
-    organisation => Faisable
-    résumé => Concrètement le 1e paragraphe du wiki
-    Compétences du socle/ Notions et compétences/ métadonnées d'indexation => Correspond à quoi concrétement ?  
-- (Section | element)*
-Les éléments sont : 
-     *Information
-     *Attention
-     *Complément
-     *Conseil
-     *Définition
-     *Exemple
-     *Hypothèse 
-     *Méthode
-     *Rappel
-    *Question avec corrigé masqué ou non 
-     => Pas forcément utile dans le cas où les articles wikipédia ne comportent pas de QCM
-
-   
-Les sections sont composées : section(titre,element*)
-*titre
-*element
-
-
-Chaque element est decoupé en : element(titre?,contenu)
-Contenu est de la forme : 
-    1.Texte multimédia (paragraphe)*
-        paragraphe :
-            possibilité de mise en page 
-                         <important/>
-                        <italique/>
-                        Citation (paragraphe)
-                        Indice
-                        Exposant
-           Liens Web (url,titre,description) -> Utilité de description ? 
-           Lien vers activité = sc:uLink role="activity" 
-           Lien vers média = sc:uLink role="media"
-           Illustration  = <sc:extBlock role="illustration" sc:refUri="/texte.activite"/>
-           Inline image 
-           Liste = puce ou ordonné
-           Tableau => A priori pas utile, parce qu'avec Wikipédia, ca sera texte + url + image c'est tout
-                        Les tableaux seront sous forme d'image 
-           
-   2.Texte vis-à-vis = pas utile pour la transfo
-   3.Zone de saisie élève , consigne élève, remarque professeur => pas utiles non plus 
-   
-Mise en relation hdoc // Canoprof
-
-   
\ No newline at end of file
+---------------------------------
+Converter : Wikipedia to Canoprof
+---------------------------------
+
+
+##### Credits #####
+
+LAINE Anna
+LAMROUS Aghiles
+
+
+
+##### Presentation #####
+
+Wikipedia to Canoprof is a converter that transforms a Wikipedia page into a Canoprof programme.
+
+
+
+##### Dependencies #####
+
+- Wikipedia to Hdoc converter
+- Hdoc to Canoprof converter
+
+
+
+##### User documentation #####
+
+Generating a Canoprof archive from the URL of the Wikipedia page:
+-----------------------------------------------------------------
+	1. Run the command corresponding to your OS:
+		
+		On Windows:
+			runURL yourWikipediaUrl yourFileName
+				yourWikipediaUrl is the URL of the Wikipedia page you would like to convert
+				yourFileName is the name of the file which will be created
+				
+			For instance: runURL https://fr.wikipedia.org/wiki/Jean_Jaur%C3%A8s jean_jaures
+			
+		On Linux:
+			sh runURL.sh yourWikipediaUrl yourFileName
+				yourWikipediaUrl is the URL of the Wikipedia page you would like to convert
+				yourFileName is the name of the file which will be created
+				
+			For instance: sh runURL.sh https://fr.wikipedia.org/wiki/Jean_Jaur%C3%A8s jean_jaures
+			
+	2. Get the .scar in the output folder.
+
+
+
+Generating a Canoprof archive from a local file containing the Wikipedia page code
+----------------------------------------------------------------------------------
+	1. Copy the source code of the Wikipedia page you would like to convert in a file called "source.xml" and put this file in the "input" directory.
+	
+	2. Run the command corresponding to your OS:
+	
+		On Windows:
+			runFile
+			
+		On Linux:
+			sh runFile.sh
+
+
+
+##### Supported functionalities #####
+
+This converter can get from a Wikipedia page images, simple tables, links. It will get the important sections, excluding the "See also", "References", "Further reading", "External links", etc...
+
+
+
+##### Known bugs #####
+
+- The display of the complex tables : actually we get an external object that we have to download, which is not that practical
+
+
+
+##### To do #####
+
+- Add the table on the right of each Wikipedia page