Skip to content

Commit

Permalink
samll readme change
Browse files Browse the repository at this point in the history
  • Loading branch information
trinker committed Dec 28, 2014
1 parent e9c253f commit cd267b3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
2. Write top to bottom, rather than a single string
3. Comment individual chunks
4. Indent expressions to represent regular expression groups
5. Add vertical line spaces and R comments (i.e., #)
5. Add vertical line spaces and R comments (i.e., `#`)
6. Test the validity of the *concatenated expression* and the modular *regular expression chunks*

This framework harnesses the power and flexibility of regular expressions but provides a structural frame that is more consistent with both code writing and natural language conventions. The user decides how to break, indent, name, and comment the regular expressions in a way that is human readable, meaningful, and modular.
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
2. Write top to bottom, rather than a single string
3. Comment individual chunks
4. Indent expressions to represent regular expression groups
5. Add vertical line spaces and R comments (i.e., #)
6. Test the validity of the *concatenated expression* and the modular chunks
5. Add vertical line spaces and R comments (i.e., `#`)
6. Test the validity of the *concatenated expression* and the modular *regular expression chunks*

This framework harnesses the power and flexibility of regular expressions but provides a structural frame that is more consistent with both code writing and natural language conventions. The user decides how to break, indent, name, and comment the regular expressions in a way that is human readable, meaningful, and modular.

Expand All @@ -39,6 +39,13 @@ devtools::install_github("trinker/regexr")
- [Web Page](http://trinker.github.com/regexr/)
- [Package PDF Help Manual](https://dl.dropboxusercontent.com/u/61803503/regexr.pdf)

## Contact

You are welcome to:
* submit suggestions and bug-reports at: <https://github.com/trinker/regexr/issues>
* send a pull request on: <https://github.com/trinker/regexr/>
* compose a friendly e-mail to: <tyler.rinker@gmail.com>

## Functions

| Function | Description |
Expand Down Expand Up @@ -410,9 +417,4 @@ out <- construct(
)
```

## Contact

You are welcome to:
* submit suggestions and bug-reports at: <https://github.com/trinker/regexr/issues>
* send a pull request on: <https://github.com/trinker/regexr/>
* compose a friendly e-mail to: <tyler.rinker@gmail.com>

0 comments on commit cd267b3

Please sign in to comment.