Skip to content

Commit 8074c1e

Browse files
committed
docs: update README and LICENSE
1 parent a8c6904 commit 8074c1e

File tree

2 files changed

+55
-5
lines changed

2 files changed

+55
-5
lines changed

LICENSE renamed to LICENSE.txt

File renamed without changes.

README.md

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,65 @@
1-
# conda_remove_env
1+
# Remove conda environments
22

3-
Remove one or more conda environments
3+
Remove multiple conda environments.
44

5-
1. Clone the repo
5+
The tool was created to bulk-remove conda environments to avoid the need to have multiple `conda env remove -n NAME` commands. Instead, you can now remove multiple environments with
66

7+
```text
8+
python conda_remove_envs.py -n NAME1 NAME2 ...
79
```
10+
11+
## Usage
12+
13+
Remove one environment
14+
15+
```text
16+
python conda_remove_envs.py -n NAME
17+
```
18+
19+
Remove multiple environments
20+
21+
```text
22+
python conda_remove_envs.py -n NAME1 NAME2
23+
```
24+
25+
## Install
26+
27+
Clone the project
28+
29+
```text
830
git clone https://github.com/trevor-moon/conda-remove-envs.git
931
```
1032

11-
2. Run with bash
33+
Change to the install location
1234

35+
```text
36+
cd conda-remove-envs
1337
```
14-
bash conda_remove_envs env1 env2
38+
39+
Use
40+
41+
```text
42+
python conda-remove-envs.py --help
1543
```
44+
45+
## Roadmap
46+
47+
- [ ] Publish to channels ([issue #4](https://www.github.com/trevor-moon/conda-remove-envs/issues/4))
48+
- [ ] Bash wrapper for python script
49+
- [ ] Setup CI & CD tools ([issue #12](https://www.github.com/trevor-moon/conda-remove-envs/issues/12))
50+
51+
## Contributing
52+
53+
See [good first issues](https://www.github.com/trevor-moon/conda-remove-envs/issues/) for quick contributions.
54+
55+
Take a look at the [open issues](https://www.github.com/trevor-moon/conda-remove-envs/issues/) and [open pull requests](https://www.github.com/trevor-moon/conda-remove-envs/pulls) for other tasks.
56+
57+
If you find any issues or want a new feature, consider [create an issue](https://www.github.com/trevor-moon/conda-remove-envs/issues/) or [create a pull-request](https://www.github.com/trevor-moon/conda-remove-envs/pulls/new).
58+
59+
## Contact
60+
61+
You can contact me at through [email](mailto:trevor.r.moon@gmail.com) or [discord](https://discordapp.com/users/477451290469859339) with the subject of the message "conda-remove-envs". That way I know why you're messaging :smile:
62+
63+
## License
64+
65+
[![The MIT License](https://img.shields.io/badge/license-MIT-gree?style=flat)](LICENSE)

0 commit comments

Comments
 (0)