Compare commits
2 Commits
2ad8206d81
...
7fccbda3dd
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7fccbda3dd | ||
|
|
137e56a1fa |
14
README.md
14
README.md
@@ -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.
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
from argparse import ArgumentParser
|
||||
from pathlib import Path
|
||||
import pathspec # use this for git style ignore
|
||||
|
||||
Reference in New Issue
Block a user