specCon18/YUNODO
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added readme

Browse source
This commit is contained in:
specCon18 2024-05-30 20:51:53 -04:00
parent a8fbe32ea5
commit 3eb05055c6
1 changed files with 22 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md Normal file
View file

@ -0,0 +1,22 @@
# YUNODO(Why you no do?)
I needed a tool to find all of my "//TODO:"s in my code so I wrote this.
## Q&A
Q:is it over engineered?
A:yes. yes it is.
Q:do I care that it's over engineered?
A:no. no I don't.
Q:should you have that it's over engineered?
A:no if you don't like it gon' now git!
## Purpose
take comments like the following and output them in a parser/reader friendly format.
#### Input:
//TODO:this is a todo comment:ODOT//
#### Output:
| File Path | File Name | Line Number | Comment |
|:----------|:---------:|:-----------:|:--------|
| ./src/ | README.md | 17 | this is a todo comment |