Skip to content

Commit 4c469e6

Browse files
authored
Enhance README with features and setup instructions
Added features section and detailed offline setup instructions.
1 parent a5b867d commit 4c469e6

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,20 @@
33
## Appearance (looks will differ depending on screen size, but the middle panel will always look the same/similar):
44
<img width="2545" height="1213" alt="Screenshot 2026-02-07 at 6 29 00 PM" src="https://github.com/user-attachments/assets/0c117212-21c0-479b-a44b-9dc6a309c385" />
55

6+
## Features:
7+
- Multiple difficulty modes including easy (7 or less letters), hard (more than 7 letters), and practice (frequently incorrect words).
8+
- Auto-grading
9+
- Button to manually add words to practice mode.
10+
- A clear cache button to reset all progress.
11+
- Ability to get the word slowed down, the word in a sentence, the word's meaning, and obviously the word itself (using built-in text-to-speech)
12+
613
## Offline Use:
714
### Note: you can't simply open the index.html file as on many Operating System's, the Text-to-Speech API for web won't work locally. Instead, you'll need to set up a local server, the simplest way being using python (instructions below).
8-
### - Initial Step: You need to have Python installed (you can get it here: https://www.python.org/downloads/), make sure to get the latest version. To check if you have python installed enter "python3 --version" or "python --version" into your terminal.
9-
### - Install the latest release of the software.
10-
### - Open up the folder in your terminal directory. (Use the cd command, for example, if the file is stored in a folder called "Bee" which is stored in another folder called "Desktop", the command would be "cd Desktop/Bee".)
11-
### - Once you are in the correct directory, enter the command "python3 -m http.server". If this doesn't work, you can try "python -m http.server". If neither works, ensure you have python installed and working. Once again, to check if you have python working enter "python3 --version" or "python --version" into your terminal.
12-
### - Now go to http://localhost:8000/. If it doesn't work, go here (https://www.youtube.com/watch?v=gwhG7rar2gU) or here (https://stackoverflow.com/questions/41810407/localhost8000-resolves-to-localhost-and-this-site-cant-be-reached-but-localh) for potential solutions. If this doesn't solve your problems, just search up your error message on Google.
13-
### - You are all done!
15+
- Initial Step: You need to have Python installed (you can get it here: https://www.python.org/downloads/), make sure to get the latest version. To check if you have python installed enter "python3 --version" or "python --version" into your terminal.
16+
- Install the latest release of the software.
17+
- Open up the folder in your terminal directory. (Use the cd command, for example, if the file is stored in a folder called "Bee" which is stored in another folder called "Desktop", the command would be "cd Desktop/Bee".)
18+
- Once you are in the correct directory, enter the command "python3 -m http.server". If this doesn't work, you can try "python -m http.server". If neither works, ensure you have python installed and working. Once again, to check if you have python working enter "python3 --version" or "python --version" into your terminal.
19+
- Now go to http://localhost:8000/. If it doesn't work, go here (https://www.youtube.com/watch?v=gwhG7rar2gU) or here (https://stackoverflow.com/questions/41810407/localhost8000-resolves-to-localhost-and-this-site-cant-be-reached-but-localh) for potential solutions. If this doesn't solve your problems, just search up your error message on Google.
20+
- You are all done!
1421

1522
## For online use, all instructions are already on the website.

0 commit comments

Comments
 (0)