Command line tool to manage RichCSS
Ruby CSS Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
exe
lib
spec
.gitignore
.rspec
Gemfile
LICENSE.txt
README.md
Rakefile
richcss.gemspec

README.md

Richcss-cli

Richcss CLI is a tool to manage your CSS using the RichCSS framework. It also includes a package manager to help install and create your own RichCSS parts for others to use.

Both CSS and SASS are supported.

Installation

Add this line to your application's Gemfile:

gem 'richcss'

And then execute:

$ bundle

Or install it yourself as:

$ gem install richcss

Usage

Using RichCSS in your project

To start, in the directory where you want to put all your CSS, run

$ richcss init [css/scss]

to create the skeleton structure. Currently, only CSS and SCSS is supported by init. The default option is CSS is the user does not state which file format to use.

Using RichCSS parts

In the directory created using richcss init, you can install third-party parts using

$ richcss install <PART> [VERSION]

The version is optional and will default to the latest version of that part.

Creating your own RichCSS Part

Generate the necessary files for your Part with

$ richcss part init <PART_NAME> [css/scss]

Publishing your Part for others to use

Before releasing your Part to the public, you may run

$ richcss part check [PART_PATH]

to make sure everything is valid. Then publish it to CSSParts with

$ richcss part push <PART_NAME> 

Development

After checking out the repo, run bundle install to install dependencies. 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/fdp-A4/richcss-cli

License

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