commit b2f15f7d71f2d5aef1b5cf2e4ffc1d8eea04f11a
parent 1e9615d8157ad429f758fe2085adb0dc2922a0ff
Author: Sharifjon Sharipov <ss2393506@gmail.com>
Date: Mon, 23 Feb 2026 08:15:49 +0000
Enhance README with usage and installation details
Updated usage instructions and added cloning steps.
Diffstat:
1 file changed, 13 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -1,5 +1,15 @@
# thcal
-CNC Thread Calculator that calculates thread parameters for CNC machining. Especially helpful for Sinumerik 808d users.
+CNC Thread Calculator that calculates thread parameters for CNC machining. Especially helpful for Sinumerik 808d users.\\
-To be able to use it, install all the necessary modules (pandas, tkinter etc.) and run:
-'python3 main.py'
+
+\textbf{\large Usage:}\\
+
+
+clone this repo:\\
+
+\texttt{ git clone https://github.com/ssharifjon/thcal}\\
+
+inside \texttt{thcal} directory, run:\\
+\texttt{python3 main.py} on linux, or\\
+\texttt{python main.py} on windows, or\\
+download the precompiled executable here: https://drive.google.com/file/d/1ryLhlwrJk1A9c4dKzxBnsKdMSRBL8keM/view?usp=sharing
