Tuxedo::Css::Rails

A gem to simplify the setup process of the Tuxedo CSS framework.

tuxedo-css-rails is easy to drop into Rails with the asset pipeline.

gem 'tuxedo-css-rails'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install tuxedo-css-rails

Import Tuxedo styles in app/assets/stylesheets/application.scss:

@import "tuxedo-css";
@import "threejs"; 

Make sure the file has .scss extension. If you have just generated a new Rails app, it may come with a .css file instead, you can rename it with:

$ mv app/assets/stylesheets/application.css app/assets/stylesheets/application.scss

Then, remove all the *= require_self and *= require_tree . statements from the sass file. Instead, use @import to import files.

Do not use *= require in Sass or your other stylesheets will not be able to access the Tuxedo mixins or variables.

Require Tuxedos Javascripts in app/assets/javascripts/application.js:

//= require jquery
//= require tuxedo-css
//= require three-render
//= require three-minified

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/DiegoSPB/tuxedo-css-rails/pulls. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.