Skip to content
This repository has been archived by the owner on Jun 24, 2024. It is now read-only.

Commit

Permalink
docs: add usage tips to readme, add executeable to start the file
Browse files Browse the repository at this point in the history
  • Loading branch information
seesmof committed Dec 22, 2023
1 parent 4bc52a9 commit 563da32
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 2 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

- [Table of contents](#table-of-contents)
- [About](#about)
- [How to Use](#how-to-use)
- [Screenshots](#screenshots)
- [Links](#links)
- [License](#license)
Expand All @@ -20,6 +21,12 @@

Word Counter is a simple and easy-to-use tool for analyzing texts and getting statistics about the number of words and characters they contain. It allows users to load texts from files and calculates various metrics such as word count, character count, and reading level. The app is designed to be straightforward and intuitive, making it a useful tool for writers, students, and anyone who needs to analyze texts quickly and easily.

## How to Use

1. [Download](https://github.com/seesmof/word-counter/releases) the files to your computer
2. Open the downloaded folder and double-click `Run.vbs` file
3. Enjoy!

## Screenshots

![Main App Tab](./public/app-screenshots/python3.10_w8UvJiBhWA.png)
Expand Down
12 changes: 12 additions & 0 deletions Run.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
@echo off

cls

if not exist "./data/requirements.txt" (
echo Installing requirements...
pip install -r requirements.txt
echo Requirements installed successfully > "./data/requirements.txt"
)

python ./src/main.py
exit
3 changes: 3 additions & 0 deletions Run.vbs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Set WshShell = CreateObject("WScript.Shell")
WshShell.Run "Run.bat", 0
Set WshShell = Nothing
Binary file removed public/logo.ico
Binary file not shown.
Binary file added requirements.txt
Binary file not shown.
1 change: 0 additions & 1 deletion src/components/PopularWords.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ def __init__(self):
self.title("Most Popular Words")
self.geometry("400x400")
self.resizable(False, False)
self.iconbitmap("public/logo.ico")

self.wordsContainer = CTkScrollableFrame(
self,
Expand Down
1 change: 0 additions & 1 deletion src/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ def configureApp() -> CTk:
app.geometry("380x390")
app.resizable(False, False)
app.title("Word Counter App")
app.iconbitmap("public/logo.ico")

app.bind("<Escape>", lambda event: closeApp(app, event=event))
set_default_color_theme("dark-blue")
Expand Down

0 comments on commit 563da32

Please sign in to comment.