# [Proton](http://sinefunc.com/proton?)
#### Proton is a website preprocessor.

http://sinefunc.com/proton/

 - __HAML, Sass, Compass and more:__ Proton will let you write in HAML, SCSS,
   Sass, and more by default. It also comes preloaded with 
   [Compass](http://compass-style.org).

 - __Layouts and Partials:__ Proton lets you define your site's header and footer
   layouts in a separate file, and even separate snippets of your site
   into reuseable components (partials). Your code will be much cleaner and
   DRYer!

 - __Template languages:__ Proton lets you write your site in any template
   language you need -- the translation will be taken care of for you.
   Proton supports HAML, LessCSS, Markdown, SASS and Textile by default, and
   more can be added through extensions.

 - __Extendable:__ Proton is easily customizable with extensions. You can add
   new helpers, new commands, support for new languages and many more by
   simply adding the extensions to your project folder. Some are even
   available as simple Ruby gems!

 - __Design fast:__ Proton comes with a web server that lets you serve up
   your site locally. Any changes to your files will be seen on your next
   browser refresh!

 - __Build your site as static HTMLs:__ You can export your site as plain
   HTML files with one simple command.

Why use Proton?
---------------

It's like building a static site, but better! You can use Proton for:

 - Building HTML prototypes
 - Building sites with no dynamic logic
 - Creating a blog where the entries are stored in a source repository

Installation
------------

    gem install protonweb

Usage
-----

Here's how you can get started:

    proton create <project_name>
    cd <project_name>
    proton build                       # <= Build the HTML files, or
    proton start                       # <= Serve via a local web server


Testing
-------

Run tests:

    rake test

To try it in a different Ruby version, you can use RVM + Bundler to make 
things easier. For instance:

    rvm use 1.8.7@proton --create     # Create a gemset
    bundle install                    # Install the needed gems on that set
    rake test

Authors
-------

Authored and maintained by Rico Sta. Cruz and Sinefunc, Inc.  
See [sinefunc.com](http://sinefunc.com) for more about our work!