Skip to content
This repository has been archived by the owner on Feb 20, 2018. It is now read-only.

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mrtazz committed Dec 6, 2011
1 parent 528da18 commit 1457218
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Expand Up @@ -10,7 +10,7 @@ Chinstrap uses 4 stages for successfully rendering mustache templates. The
scanner runs through the template and emits single characters to work with. In scanner runs through the template and emits single characters to work with. In
the next stage the lexer creates meaningful (in the mustache context) tokens of the next stage the lexer creates meaningful (in the mustache context) tokens of
the retrieved characters. These token are then given to the parser, which knows the retrieved characters. These token are then given to the parser, which knows
the [state machine]() to render mustache templates and creates a parse tree the state machine to render mustache templates and creates a parse tree
based on it. The parse tree is then passed to the renderer along with the based on it. The parse tree is then passed to the renderer along with the
context to create the rendered template. context to create the rendered template.


Expand All @@ -34,20 +34,21 @@ context to create the rendered template.
make all install make all install


## Dependencies ## Dependencies
- [yajl](https://github.com/lloyd/yajl) for unit testing - [check](http://check.sourceforge.net/) for unit testing


## Meta ## Meta
- [Bugs](http://github.com/chinstrap/issues) - [Bugs](http://github.com/chinstrap/issues)
- [Features](https://pivotaltracker.com/000000)


## Contribute ## Contribute
If you want to contribute: If you want to contribute:


- Fork the project. - Fork the project.
- Make your feature addition or bug fix based on develop. - Make your feature addition or bug fix based on develop.
- Add tests for it. This is important so I don’t break it in a future version unintentionally. - Add tests for it. This is important so I don't break it in a future version
unintentionally.
- Commit, do not mess with version - Commit, do not mess with version
- Send me a pull request. Bonus points for topic branches. - Send me a pull request. Bonus points for topic branches.


## Related ## Related
- If you want a more data model agnostic parser checkout [crustache]() - If you want a more data model agnostic parser checkout
[crustache](https://github.com/tanoku/crustache)

0 comments on commit 1457218

Please sign in to comment.