Update README.md

This commit is contained in:
Steven Carpenter 2024-05-30 20:56:32 -04:00 committed by GitHub
parent 4917f464a2
commit cc32cb1078
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -2,19 +2,19 @@
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**: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**: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!
**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//
`//TODO:this is a todo comment:ODOT//`
#### Output:
| File Path | File Name | Line Number | Comment |