Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix README.md formatting #6

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix README.md formatting #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
#Outlaw
# Outlaw

##Keep bad code out of your projects. Your idea of bad code, no one elses.
##Because good documentation should be executable.
## Keep bad code out of your projects. Your idea of bad code, no one elses. Because good documentation should be executable.

I'm proud to say Outlaw has been featured on [Ruby5](http://ruby5.envylabs.com/episodes/315-episode-311-october-5th-2012/stories/2751-thank-you-for-listening-to-ruby5#story-9) and [The Ruby Show](http://rubyshow.com/episodes/197)! I also apoogize for the lack of updates, but I've been sporadically trying to interest other developers in helping to flesh out the use cases for rules they'd like to use in real projects, both ones that work with the existing gem and ones to help prioritize development of the rules engine going forward.

Real world desires and use cases are currently my priority above the planned features below, and some additional plans for a git gem I hope to develop and use with Outlaw to facilitate installing git commit hooks for running outlaw on a project on each commit. Even if you have no plans to contribute to the project directly, please fork and write up some example rules you'd like to see supported, or that you'd like to see adopted into the default rules that ship with outlaw, so I can get a better feel for how it can best serve the community.

###NOTE: Outlaw can evaluate any version ruby code, *BUT* it runs on only 1.9 -- set your system ruby to 1.9 to use
### NOTE: Outlaw can evaluate any version ruby code, *BUT* it runs on only 1.9 -- set your system ruby to 1.9 to use

### Part of MendicantUniversity.org S10 class, personal project.

Expand Down Expand Up @@ -84,7 +83,7 @@ gem and will be loaded if no .outlawed file is found in current directory or
home directory, and will warn you to provide a real file (and provide
location of the sample file in your system from the gem installation).

###Planned features (unimplemented):
### Planned features (unimplemented):
* Customize sensitivity, for instance whitespace is currently ignored, but
could enforce style conventions with some whitespace sensitive rules.
Also ignores parens, which might be required or prohibited in some
Expand Down