thcal

commit 8c5ed5a8abc32d1595c11a09b7f85643fdd0dd39
parent 7bdacde514590c43ddbc0fedd99e505b43781b6e
Author: Sharifjon Sharipov <ss2393506@gmail.com>
Date:   Mon, 30 Mar 2026 15:20:33 +0000

update readme
Diffstat:
M
README.md
 | 
25
+++++++++++++++++++------

1 file changed, 19 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
@@ -1,15 +1,28 @@
 CNC Thread Calculator that calculates thread parameters for CNC machining. Especially helpful for Sinumerik 808d users.
 
-## Usage
+## Dependencies
 
-Clone this repo:
+```
+tkinter
+pandas
+```
+
+## Usage
+On Linux:
 
 ```
 git clone https://github.com/ssharifjon/thcal
 ```
+If you use nix package manager and have enabled the use of flakes, enter the nix development shell by doing the following inside ``` thcal ``` directory:
+
+```
+nix develop
+```
+The above will install tkinter module for python. If you don't use nix, then install tkinter through your own package manager. The rest of the dependencies can be installed through ``` pip ```.
+
+Then simply run:
+`python3 main.py`
 
-Inside the `thcal` directory, run:
-- `python3 main.py` on Linux, or
-- `python main.py` on Windows, or
-- Download the precompiled executable for Windows [here](https://drive.google.com/file/d/1ryLhlwrJk1A9c4dKzxBnsKdMSRBL8keM/view?usp=sharing)
+On Windows:
 
+Download the executable [here](https://drive.google.com/file/d/1ryLhlwrJk1A9c4dKzxBnsKdMSRBL8keM/view?usp=sharing).