Browse Source

Add description to README

experimental
Bogdan Cordier 7 years ago
parent
commit
1d9082cfde
1 changed files with 34 additions and 7 deletions
  1. 34
    7
      README

+ 34
- 7
README View File

@@ -8,16 +8,43 @@ KCnrtl
8 8
 :Version: 0.1
9 9
 
10 10
 
11
-DESCRIPTION
11
+Description
12 12
 ===========
13 13
 
14
-KCnrtl is a simple KDE graphical client to access the CNRTL linguistic resources.
14
+KCnrtl is a simple KDE graphical client to access the CNRTL french linguistic resources.
15 15
 It offers the possibility to check the definitions, synomyms, antonyms of a given
16 16
 french word.
17 17
 
18
-With the "Clipboard mode" you can easily check for a synonym/antonym
19
-and replace it in your text. To do so, juste check the "Clipboard mode" checkbox,
20
-copy in the clipboard any word, KCnrtl will do an automatic request to the CNRTL
21
-website and you can easily copy any synomym or antonym by just clicking on them.
22
-Now you just have to paste it back in you text ! 
18
+Features:
19
+---------
20
+
21
+    *Check the definitions, synomyms, antonyms of any given french word
22
+      For now the TLFi (Trésor de la Langue Française) is the only available dictionary.
23
+
24
+    *The "AMAZING Clipboard mode" :
25
+      With the "Clipboard mode" you can easily check for a synonym/antonym and replace it in your text.
26
+    To do so, just check the "Clipboard mode" checkbox, copy in the clipboard any word, KCnrtl will do
27
+    an automatic request to the CNRTL website and you can easily copy any synomym or antonym by
28
+    just clicking on them.
29
+    Now you just have to paste it back in you text !
30
+
31
+Planned features:
32
+-----------------
33
+
34
+    *cli client
35
+    *access to other dictionary offered by the CNRTL (Dictionnaire de l'Académie française 9e, etc)
36
+
37
+Installation
38
+============
39
+
40
+Decompress the archive, you can launch the program by running kcnrtl.sh
41
+
42
+TODO
43
+
44
+Dependencies
45
+============
46
+
47
+*httplib2
48
+*BeautifulSoup4
49
+*PyQT
23 50
  

Loading…
Cancel
Save