Skip to content

Latest commit

 

History

History
72 lines (35 loc) · 2.55 KB

README.md

File metadata and controls

72 lines (35 loc) · 2.55 KB

Cactu

Gem version

Cactu is a Sass framework to create webs easily, created to be simple, semantic, fast to learn, customizable, and scalable.

Installation

Ruby on Rails

Add this line to your application's Gemfile:

gem 'cactu', '~> 0.20.1'

Ensure that sprockets-rails is at least v2.3.2.

And then execute:

$ bundle

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

// Custom Cactu global-variables (if you need it) *before* Cactu.
@import "cactu";

Make sure the file has .scss. If you have just generated a new Rails app, it may come with a .css file instead. If this file exists, it will be served instead of Sass, so rename it:

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

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

If you use *= require in Sass or your other stylesheets, you will not be able to access the Cactu framework.

Another Ruby framework

Type this in your terminal:

$ gem install cactu

Usage

Go for Documentation to know more about the Cactu's usage.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mendozagioo/cactu-ruby. 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.

Code of Conduct

Everyone interacting in the Cactu project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Author

Giovanni Mendoza

Copyright and license

Code released under the MIT License