Skip to content

Commit 9eb300d

Browse files
new version of README.md
1 parent eba1e2a commit 9eb300d

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

vocabulary log helper/README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
### This project is used for searching synonyms and antonyms for many words as fast as it can.
33

44
## What is vocabulary log?
5-
**vocabulary log** is a college assignment that require the student to search for the synonyms, antonyms of certain words and make a statement using that word, I am a first year college student and I had a hard time doing this assignment because the time that it can take from me, so I decided to make a code that can help me with the assignment.
5+
**vocabulary log** is a college assignment that require the student to search for the synonyms, antonyms of certain words and make a statement using that word, I am a first year college student and I had a hard time doing this assignment because the time it can take, so I decided to make a code that can help me with the assignment.
66

77
## How does the code work?
88
This code work as following :<br>
@@ -13,4 +13,26 @@ This code work as following :<br>
1313

1414
## Features I want to add to this project:
1515
- Output the data as an excel file
16-
- Add a GUI for better user experience
16+
- Add a GUI for better user experience
17+
18+
19+
## Files in project:
20+
- `LogHelper.py` : this file is an asynchronous version of the code, I made this version so I can make the part of the code take less time.
21+
- `LogHelperSync.py` : this is the original version of the code, it is synchronous and take much more time for much more words.
22+
23+
## Requirement to run this code:
24+
- **aiohttp** module for asynchronous requests, to install run this command in the terminal
25+
26+
```bash
27+
pip install aiohttp
28+
```
29+
- **typing** defines a standard notation for Python function and variable type annotations.
30+
31+
```bash
32+
pip install typing
33+
```
34+
- **Beautiful Soup** is a library that makes it easy to scrape information from web pages.
35+
36+
```bash
37+
pip install BeautifulSoup
38+
```

0 commit comments

Comments
 (0)