interface/draincleaner
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added MacOS usage instructions

Browse Source
This commit is contained in:
interface
2026-02-21 15:11:12 +01:00
parent 137e56a1fa
commit 7fccbda3dd
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -4,7 +4,7 @@ Remove comments from source files.
**Disclaimer: This software is not extensively tested so should only be used used for testing right now**
## Installation and use
## Installation instructions (Linux and MacOS)
This is how I would install and use this, I haven't spent any time to package it properly.
@@ -18,14 +18,20 @@ Make the draincleaner.py executable
$ chmod +x draincleaner.py
```
In your .bashrc file add the following, but change path to your draincleaner directory:
In your .bashrc file located in your users home directory (on MacOS it's the .zshrc file in /Users/user/) add the following:
```bash
draincleaner() {
/path/to/draincleaner.py "$@"
}
```
change the path to point to the directory where draincleaner is located.
Done. Now you can run it anywhere by typing:
Done. Now you can run it anywhere from your terminal by typing:
```
$ draincleaner
```
```
# Known issues
* --show-strings fails to detect and print f-strings.