nicolo/crapgrep
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update .gitignore and README

Browse Source
This commit is contained in:
Nicolo P 2022-02-15 20:53:29 +01:00
parent 1785bdd9c0
commit 0d0cfac860
2 changed files with 29 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.gitignore vendored
View File

@ -1,5 +1,11 @@
# Vim stuff
*.swp *.swp
*.vim
# Test files
test_f*.txt test_f*.txt
# venv
bin bin
lib* lib*
*.cfg *.cfg

25
README.md
View File

@ -17,6 +17,21 @@ python crapgrep.py [OPTIONS] [PATTERN] [FILE[...]]
_**Note**: obviously, `crapgrep` doesn't read from `stdin`, which makes it even more useless..._ _**Note**: obviously, `crapgrep` doesn't read from `stdin`, which makes it even more useless..._
## Installation
If you like wasting time because apparently you have nothing better to do, you can try `crapgrep` by cloning the repository with `git`:
```bash
git clone https://baltig.cnr.it//nicolo.paraciani//crapgrep.git
```
then
```bash
cd crapgrep
python crapgrep.py <option> <file(s)>
```
## Examples ## Examples
The examples below assume that `python` is an alias of `python3`. The examples below assume that `python` is an alias of `python3`.
@ -75,12 +90,18 @@ meaning that the matches were found in lines `5` and `73` of `garbage1.txt` and
Ehm... Ehm...
## Why ## Why?!
If you're asking yourself: "_Why would you inflict something like this upon the world?_", the answer is... because it's fun! If you're asking yourself:
> _Why would you inflict something like this upon the world?_
the answer is... _because it's fun!_
## TODO ## TODO
- [ ] Implement the recursive search option (`-r`) - [ ] Implement the recursive search option (`-r`)
- [ ] Implement long options (e.g.,`--ignore-case`) - [ ] Implement long options (e.g.,`--ignore-case`)
- [ ] Add colors to terminal output with `sty`
- [ ] Add a few tests
- [ ] Abandon the project!! - [ ] Abandon the project!!