Skip to content

Commit cd797ac

Browse files
committed
Readme updated.
1 parent 3615988 commit cd797ac

File tree

1 file changed

+35
-37
lines changed

1 file changed

+35
-37
lines changed

003 - D5L Dictionary/README.md

Lines changed: 35 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@
55
![Static Badge](https://img.shields.io/badge/IDE-VsCode-blue)
66
![Static Badge](https://img.shields.io/badge/D5L-Dictionary-orange)
77

8-
98
<img src="https://hatscripts.github.io/circle-flags/flags/uk.svg" width="24"> <img src="https://hatscripts.github.io/circle-flags/flags/tr.svg" width="24"> <img src="https://hatscripts.github.io/circle-flags/flags/fr.svg" width="24"> <img src="https://hatscripts.github.io/circle-flags/flags/cn.svg" width="24"> <img src="https://hatscripts.github.io/circle-flags/flags/ru.svg" width="24">
109

11-
1210
![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)
1311

1412
# CONTENTS
@@ -20,33 +18,32 @@
2018
5. [Known issues](#known-issues)
2119
6. [Contact & Forum & Wiki](#contact)
2220

23-
**********************************
21+
---
2422

2523
## Introduction
2624

27-
D5L is a dictionary with 5 languages. It includes English, Turkish, French, Russian and simple Chinese.
28-
The main goal of D5L dictionary is to find meaning, synonym and antonym of words in these 5 languages.
25+
D5L is a dictionary with 5 languages. It includes English, Turkish, French, Russian, and Simplified Chinese. The main goal of D5L dictionary is to find the meaning, synonym, and antonym of words in these 5 languages.
2926

30-
- D5L is written in python and includes a Tkinter.
31-
- Searches meaning of words, synonymes, antonymes in English, Turkish, French, Russian and Chinese.
32-
- Using PyMultiDictionary as database.
27+
- D5L is written in Python and includes Tkinter.
28+
- Searches meaning of words, synonyms, antonyms in English, Turkish, French, Russian, and Chinese.
29+
- Using PyMultiDictionary as the database.
3330
- Requirements: Tkinter, Messagebox, Pymultidictionary.
34-
- Use help menu (F1) to have more information and support.
31+
-Use the help menu (F1) to have more information and support.
3532

3633
## How to Install
3734

38-
Various ways of installing the D5L:
35+
You can install D5L in various ways:
3936

40-
- Fork the repository to your Github and run main.py
41-
- Download the .exe file for windows. (soon!)
42-
- Install via flathub for Linux. (soon!)
43-
- Download .deb file for Linux. (soon!)
44-
- Download main.py, constants,py, gui_utils.py, menu_utils.py and run main.py
45-
- main.py for English.
46-
- main_fr.py for French. (not functional yet)
47-
- main_ru.py for Russian. (not functional yet)
48-
- main_ch.pt for Chinese. (not functional yet)
49-
- main_tr.py for Turkish. (not functional yet)
37+
- Fork the repository to your GitHub and run main.py.
38+
- Download the .exe file for Windows (coming soon!).
39+
- Install via Flathub for Linux (coming soon!).
40+
- Download the .deb file for Linux (coming soon!).
41+
- Download main.py, constants.py, gui_utils.py, and menu_utils.py, and run main.py.
42+
- main.py for English.
43+
- main_fr.py for French (not functional yet).
44+
- main_ru.py for Russian (not functional yet).
45+
- main_ch.py for Chinese (not functional yet).
46+
- main_tr.py for Turkish (not functional yet).
5047

5148
Installing necessary modules:
5249

@@ -58,35 +55,36 @@ pip install Pymultidictionary
5855

5956
🌟 Searching a Word
6057

61-
- Select first the language you want to make the search.
62-
- Type any word in selected language in search boxes.
63-
- Use meaning, synonym, antonym to search for the meaning, synonym or antonym of a word.
64-
- Search button or enter key works as well.
65-
- Use copy button to copy your search result.
66-
- Use clear button to clear the search and the result area.
67-
- If you have any questions or suggestions use [Disccusions](https://github.com/storlak/PythonMiniProjects/discussions)
68-
- If the word you're looking for is not in the dictionary search result retrns ([], ",")
58+
- Select the language you want to search first.
59+
- Type any word in the selected language into the search boxes.
60+
- Use "meaning," "synonym," or "antonym" to search for the meaning, synonym, or antonym of a word.
61+
- The search button or Enter key works as well.
62+
- Use the copy button to copy your search result.
63+
- Use the clear button to clear the search and the result area.
64+
- If you have any questions or suggestions, use [Disccusions](https://github.com/storlak/PythonMiniProjects/discussions).
65+
- If the word you're looking for is not in the dictionary, the search result returns ([], ",").
6966

7067
🌟 Avoid the following while searching!
7168

72-
- Don't add "s", plural in the end of the word. Search returns null.
73-
- If you're searching a verb don't use "to". write "help" instead of "to help"
69+
- Don't add "s" at the end of the word. Searches return null.
70+
- If you're searching for a verb, don't use "to". Write "help" instead of "to help".
7471

7572
## Roadmap
7673

77-
- More languages to be added!
78-
- App will be converted to .exe file for windows.
79-
- App will be converted to flatpak and will be published in flathub repo.
80-
- Deb package to be created.
74+
- More languages will be added!
75+
- Keyboard shortcuts - uick commands will be revised.
76+
- The app will be converted to an .exe file for Windows.
77+
- The app will be converted to Flatpak and published in the Flathub repository.
78+
- A Deb package will be created.
79+
- AppImage will be created.
8180

8281
## Known issues
8382

84-
- 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.
83+
- Search results in any language besides English come first with the English definition. An issue ticket has been opened to the PyMultiDictionary module. You can view it [here](https://github.com/storlak/PythonMiniProjects/issues/2).
8584
- Tool menu items (switch language) are not functional yet.
8685

8786
## Contact
87+
8888
[![Gmail Badge](https://img.shields.io/badge/-serdartorlak-c14438?style=flat&logo=Gmail&logoColor=white&link=mailto:[email protected])](mailto:[email protected])
8989
![Mastodon Follow](https://img.shields.io/mastodon/follow/111266776829036638?style=flat&logo=mastodon&color=blue)
9090
[![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)
91-
92-

0 commit comments

Comments
 (0)