Лийр Library

A pear flavored SCSS library.

Installation

1. Create a new directory called lib inside your SCSS directory. (You can call the new directory anything you want just make sure you're consistant.)

   $ cd yoursite.com/scss/
   $ mkdir lib
   $ cd lib

2. Initalize git and clone this repo into the new lib directory.

   $ git init
   $ git remote add origin git@github.com:Alekhen/liir-lib.git
   $ git fetch
   $ git checkout -t origin/master

3. Copy the _variables.scss file from the library into the parent directory and rename it as _lib-config.scss. File name and location are important here since the Лийр Library will need to access this file. _lib-config.scss is where you can customize the library's compiled output by overwriting the default variables.

   $ cp _variables.scss ../_lib-config.scss

4. Open the new _lib-config.scss file you created in the parent directory with your favorite text editor and change the variable defininitions to your heart's content.

5. Include the lib/_liir.scss file in your project and you're good to go.

   @import "lib/liir";

6. Optional: If you ONLY want access to Лийр's mixin library you can choose to include lib/mixins/_config.scss instead of lib/_liir.scss in your project.

   @import "lib/mixins/config";

7. Optional: Add the lib directory to your .gitignore file if you don't want the Лийр Library to be stored in your project repo.

Change Log

v1.0 - Current Version

License

Copyright © 2014, Hazard Media Group LLC

• MIT License

Development

• Source hosted at GitHub.

Author

Colton James Wiscombe