Browse Source

Update 'README.md'

master
Daniel 2 months ago
parent
commit
890e624ed6
1 changed files with 20 additions and 12 deletions
  1. +20
    -12
      README.md

+ 20
- 12
README.md View File

@@ -1,20 +1,28 @@
# FBRP
"Flexible Bible Reference Parser"

## Features
* C99
* No Regex or any other libraries
* Tiny and fast
* One C file
* Tiny and flexible
* One C file, one header file, no complex build system needed.

### Can Parse:
"John 3 16"
"2 John 3 16-17"
"2 Kings 1, 3-5:2-4, 3-6, 1-2"
## Can Parse:
- "John 3 16"
- "2 John 3 16-17"
- "2 Kings 1, 3-5:2-4, 3-6, 1-2"

### Cannot Parse:
## Cannot Parse:
By design, it cannot parse references like:
"John 3 16, John 3 17"
"John 3, Hebrews 4"
- "John 3 16, John 3 17"
- "John 3, Hebrews 4"
- "John 3 16, KJV"

## Testing:
`cc test.c fbrp.c && ./a.out`

### Testing:
`cc test.c fbrp.c && ./a.out`
## How it works:
Like a typical compiler, it parses the string into a "token"
tree. Then, it uses that to run through each token and figure out
exactly what they all mean.
There is currently no algorithm specification, but feel free to
ask if you need any clarification.

Loading…
Cancel
Save