Awesome

Caramel

Caramel is a simple, modern, responsive website framework. Caramel is fully responsive, meaning you only need to write code once, to have the same results across multiple platforms. Created by kurisubrooks, Caramel is being developed with help from the open-source community on GitHub.

Getting Started

• Download the latest Release
• Download the latest Development Build
• Clone the repo: git clone https://github.com/lumios/caramel.git

Quick Start

Jump right into Caramel by using the included HTML5 Boilerplate. template.html is already set up to HTML5 standards, and has Caramel already included. All you need to do is to start writing your code!

Also, check out showcase.html, to see Caramel's latest features!

What's included?

Our public releases only contain the files that are necessary for front-end development. If you'd like to develop for, or modify Caramel, we'd recommend downloading the Development Build, which includes our build tool, and the sass source files.

caramel/
├── showcase.html
├── template.html
│
├── css/
│   ├── caramel.css
│   └── caramel.min.css
│
├── js/
│   ├── caramel.js
│   ├── caramel.min.js
│   └── jquery.min.js
│
└── fonts/
    └── fontawesome/

Documentation

Head on over to our website, and view the Showcase. All code usage and examples are listed right there on the page! If you want to see the exact syntax we use to show you the content on the page, simply right click on the page and view source (depending on whether your browser supports this feature).

Still stuck or need further help? Tweet @kurisubrooks, and he'll try to answer any questions you may have.

Compiling

We've included an easy and hassle free way for you to compile Caramel. We've included our own Gulp build tool, that you can use to compile Caramel.

Required:

Our compiler runs on Node.js, so before you can continue, please ensure that you have it installed. Once you have Node installed, you'll need Gulp. If you already have both Node and Gulp installed, skip these steps, otherwise install Node.js from their website, then run the following command to install Gulp:

npm install gulp --global

Note: You may need to run this command with sudo on macOS

Install:

To get the latest version of Caramel and to install the build tools, run the following set of commands:

cd ~/.../caramel
git clone https://github.com/lumios/caramel.git
npm install

Usage:

To run the build tool, run the following command:

gulp

After the build is complete, the output caramel.css, caramel.min.css and caramel.min.js files can be found in your ./src/css and ./src/js folders respectively.

Compatibility

Caramel has been designed for any browser that supports CSS3. Caramel has been tested, and is recommended for use on:

Legal

Copyright (c) 2016 Lumios – All Rights Reserved.

Permission is hereby granted, free of charge, to any persons obtaining
a copy of this software, to deal this software within the agreed guidelines.

Copying, modification, contribution, non-commercial distribution and/or
sub-licensing this software are allowed, so long as you are subject to the
following conditions:

The above copyright notice and this permission notice will be included in all
copies, un-modified, within the Software.
Licensing and security checks may not be removed.
Republication of this software for personal or commercial gain is prohibited.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.