D5L Readme revised.

Author: storlak

003 - D5L Dictionary/README.md

@@ -6,47 +6,63 @@
 
 ![Views Counter](https://views-counter.vercel.app/badge?pageId=https%3A%2F%2Fgithub%2Ecom%2Fstorlak%2FPythonMiniProjects&leftColor=000000&rightColor=0adb3f&type=total&label=Viewers&style=none)
 
-🌟 Introduction
+# CONTENTS
+1. [Introduction](#introduction)
+2. [How to use?](#how-to-use)
+3. [Roadmap](#roadmap)
+4. [Knwon issues](#known-issues)
 
-D5L is a dictionary with 5 languages. It includes English, Turkish, French, Russian and Chinese.
+**********************************
+
+## Introduction
+
+D5L is a dictionary with 5 languages. It includes English, Turkish, French, Russian and simple Chinese.
 The main goal of ENG5 dictionary is to find meaning, synonym and antonym of words in these 5 languages.
 
-- D5L includes a simlie Tkinter interface written in Python.
-- Searches words, synonymes, antonymes in English, Turkish, French, Russian and Chinese.
+- D5L is written in python and includes a Tkinter.
+- Searches meaning of words, synonymes, antonymes in English, Turkish, French, Russian and Chinese.
 - Using PyMultiDictionary as database.
-- Requirements: Tkinter, Messagebox, Pymultidictionary
-- Search button or enter key works as well.
-- Use help menu to contact further info.
+- Requirements: Tkinter, Messagebox, Pymultidictionary.
+- Use help menu (F1) to contact further info.
 
-For installing modules:
+Installing necessary modules:
 
 ```
 pip install Pymultidictionary
 ```
 
-🌟 How to use?
+## How to use?
 
-### Searching a Word
+🌟 Searching a Word
 
-- Select first the language you want search.
+- Select first the language you want to make the search.
 - Type any word in selected language in search boxes.
-- Use meaning, synonym, antonym to search the meaning, synonym and antonym of a word.
-- Use clear button to clear the search and explanation area.
+- Use meaning, synonym, antonym to search for the meaning, synonym or antonym of a word.
+- Search button or enter key works as well.
 - Use copy button to copy your search result.
+- Use clear button to clear the search and the result area.
 - If you have any questions or suggestions use [Disccusions](https://github.com/storlak/PythonMiniProjects/discussions)
+- If the word you're looking for is not in the dictionary search result retrns ([], ",")
 
-### Avoid the following while searching!
+🌟 Avoid the following while searching!
 
 - Don't add "s", plural in the end of the word. Search returns null.
 - If you're searching a verb don't use "to". write "help" instead of "to help"
 
-🌟 Roadmap
+## Roadmap
+
+- More languages to be added!
+- App will be converted to .exe file for windows.
+- App will be converted to flatpak and will be published in flathub repo.
+- Deb package to be created.
 
-- Soon other languages will be added!
-- It will be converted to an .exe file.
-- D5L will be converted to flatpak and update to flatpak repo.
-- Deb package will be created.
+## Known issues
 
-🌟 Contact Me for any suggestions!
+- Search result in any language besides English comes first with English definition. [Issue ticket](https://github.com/storlak/PythonMiniProjects/issues/2) opened to PyMultiDictionary module.
+- Tool menu items (switch language) are not functional yet.
 
+## Contact
 [![Gmail Badge](https://img.shields.io/badge/-serdartorlak-c14438?style=flat&logo=Gmail&logoColor=white&link=mailto:[email protected])](mailto:[email protected])
+![Mastodon Follow](https://img.shields.io/mastodon/follow/111266776829036638?style=flat&logo=mastodon&color=blue)
+[![Twitter Badge](https://img.shields.io/badge/-@serdartorlak-1ca0f1?style=flat&labelColor=1ca0f1&logo=twitter&logoColor=white&link=https://twitter.com/serdartorlak)](https://twitter.com/serdartorlak)
+