Skip to content

Latest commit

 

History

History
87 lines (62 loc) · 3.58 KB

README.md

File metadata and controls

87 lines (62 loc) · 3.58 KB
Raw

Assembler

A library that allows you to create sites & web apps with ease

Table of contents

Quick Start

Four quick start options are available:

  • Download the latest release.
  • Clone the repo: git clone https://github.rp-core.com/chrisopedia/assembler.git.
  • Install with Bower: bower install assembler.
  • Install with component(1): component install assembler.
  • Install with npm: npm install assembler.

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:

assembler/
└── dist/
    ├── styles/
    │   ├── assembler.css
    │   ├── assembler.css.map
    │   ├── assembler.min.css
    └── scripts/
        ├── assembler.js
        └── assembler.min.js

Provided are compiled CSS and JS (assembler.*), as well as compiled and minified CSS and JS (assembler.min.*). CSS source maps (assembler.*.map) are available for use with certain browsers' developer tools.

Bugs and feature requests

Have a bug or a feature request? Please first read the Contributing documentation and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

assembler's documentation is a Jekyll-based site and is publicly hosted on GitHub Pages. You may also run the docs locally.

Running documentation locally

Github has a great guide for setting up Jekyll for use with Github pages. I've outlined the basics below.

  1. Install Ruby, if you don't already have it. Should be version 1.9.3 or better.
  2. Install Bundler via gem install bundler.
  3. Install Jekyll (requires v2.5.x). Run bundle install from the root directory.
  4. Change into the /assembler directory and run grunt dev in the command line.
  5. Open http://127.0.0.1:8000 in your browser.

❗ Note Windows users: Read this unofficial guide to get Jekyll up and running without problems.

Contributing

Contribution is a perfect way to help advance the project. Please read the contributing guidelines. before getting started.

Editor preferences are available in the editor config for use in common text editors. Read more and download plugins at http://editorconfig.org.

❗ This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.

Copyright

©️ 2015. See the LICENSE