Skip to content

Commit f3d4642

Browse files
committed
docs: update README to clarify virtual environment search and usage instructions
1 parent c74af32 commit f3d4642

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525

2626
## Features
2727

28-
- **Automatic search:** Finds all `.venv` directories recursively within a specified path.
29-
- **Support to Conda:** Lists all Conda envs.
28+
- **Automatic search:** Finds all .venv directories and any folders containing a pyvenv.cfg file recursively from the current working directory, as they are considered virtual environment folders.
29+
- **Support for Conda**: Lists all available Conda environments.
3030
- **Safe deletion:** Lists the directories to be deleted and asks for confirmation.
3131
- **Fast and lightweight:** Minimal dependencies for quick execution.
3232

@@ -40,12 +40,24 @@ pip install KillPy
4040

4141
## Usage
4242

43-
Run the following command to search and delete .venv directories and list Conda environments from the current directory and all its subdirectories recursively:
43+
Run the following command to search for `.venv` directories and any folders containing a `pyvenv.cfg` file, as well as to list all `Conda environments` from the current directory and all its subdirectories recursively:
4444

4545
```bash
4646
killpy
4747
```
4848

49+
- To **close the application**, press `Ctrl+Q`.
50+
- To **delete a virtual environment**, press `Space` (afte selecting the environment you want to delete).
51+
52+
## Roadmap
53+
54+
- [ ] Delete `__pycache__` Files
55+
- [ ] Remove `dist` Folders and Build Artifacts
56+
- [ ] Clean Up Installed Package Cache
57+
- [ ] Delete `.egg-info` and `.dist-info` Files
58+
- [ ] Analyze and Remove Unused Dependencies
59+
- [ ] Optimize Disk Space in Python Projects
60+
4961
## Contributing
5062

5163
Contributions are welcome! If you'd like to improve this tool, feel free to fork the repository and submit a pull request.

0 commit comments

Comments
 (0)