Commit 7b94e743 authored by David Haynes's avatar David Haynes

Cram together our README's

parent 16ade2cf
Bootswatch
==========
# Masonstrap (GMU bootstrap theme)
[![Bootswatch Logo](./assets/img/logo-dark.png)](http://bootswatch.com)
A project of [GMU SRCT](http://srct.gmu.edu).
Bootswatch is a collection of open source themes for [Bootstrap](http://getbootstrap.com/). Check it out at [bootswatch.com](http://bootswatch.com).
Masonstrap is a custom theme for bootstrap customized with GMU brand colors and elements.
It aims to easily provide any web project with Mason branding.
Usage
-----
Download the `bootstrap.min.css` file associated with a theme and replace Bootstrap's default stylesheet. You must still include Bootstrap's JavaScript file to have functional dropdowns, modals, etc.
## Enabling Masonstrap for Your Project
<legend></legend>
The themes are also hosted on [BootstrapCDN](http://www.bootstrapcdn.com/bootswatch/).
All you need to do is to take _bootstrap.min.css_ and add it to the static files for your project.
You can import a theme into your styles using either LESS or SASS.
Masonstrap bundles bootstrap 3.0 and normalize.css for you.
LESS:
```
@import "bootstrap/less/bootstrap.less";
@import "bootswatch/theme/variables.less";
@import "bootswatch/theme/bootswatch.less";
## Making Changes to Masonstrap
<legend></legend>
```
If you would like to make changes to values or behaviors in Masonstrap you will need to do some quick setup.
SASS:
Ensure node.js is installed:
```
@import "bootswatch/theme/variables";
@import "bootstrap-sass-official/assets/stylesheets/bootstrap";
@import "bootswatch/theme/bootswatch";
On Ubuntu: `$ sudo apt-get install npm`
On OS X, make sure you have [Homebrew](http://brew.sh) then `$ brew install node`
On Windows, download it [here](https://nodejs.org/en/download/).
```
and in the root directory of this project (bootswatch/) run:
`$ npm install`
Customization
------
Bootswatch is open source and you’re welcome to modify the themes.
Each theme consists of two LESS files. `variables.less`, which is included by default in Bootstrap, allows you to customize [these settings](http://getbootstrap.com/customize/#less-variables). `bootswatch.less` introduces more extensive structural changes.
These files are also available in SASS.
Check out the [Help page](http://bootswatch.com/help/) for more details on building your own theme.
API
-----
A simple API is available for integrating your platform with Bootswatch. More info at http://bootswatch.com/help/#api
You will also need to have Grunt installed globally on your system:
Contributing
-----
It's through your contributions that Bootswatch will continue to improve. You can contribute in several ways.
`$ npm install -g grunt-cli`
**Issues:** Provide a detailed report of any bugs you encounter and open an issue on [GitHub](https://github.com/thomaspark/bootswatch/issues).
Finally, run:
**Documentation:** If you'd like to fix a typo or beef up the docs, you can fork the project, make your changes, and submit a pull request.
`$ grunt watch`
**Code:** Make a fix and submit it as a pull request. When making changes, it's important to keep the CSS, LESS and SASS versions in sync. To do this, be sure to edit the LESS source files for the particular theme, then run the tasks `grunt swatch` and `grunt:convert_less` to build the CSS and LESS.
in order for Grunt to rebuild the bootstrap files.
**Donation:** Donations are gratefully accepted via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&amp;hosted_button_id=F22JEM3Q78JC2) and [Gratipay](https://gratipay.com/bootswatch/).
After that, you are free to make whatever changes you like to _variables.less_ and _bootswatch.less_ and _bootstrap.min.css_ will be updated accordingly.
Author
------
Thomas Park
+ http://github.com/thomaspark
+ http://thomaspark.co
Thanks
Customization
------
[Mark Otto](https://github.com/mdo) and [Jacob Thornton](https://github.com/fat) for [Bootstrap](https://github.com/twbs/bootstrap).
[Jenil Gogari](http://www.jgog.in/) for his contributions to the Flatly theme.
[James Taylor](https://github.com/jostylr) for [cors-lite](https://github.com/jostylr/cors-lite).
[Corey Sewell](https://github.com/cjsewell) for SASS conversion.
Bootswatch is open source and you’re welcome to modify the themes.
Each theme consists of two LESS files. `variables.less`, which is included by default in Bootstrap, allows you to customize [these settings](http://getbootstrap.com/customize/#less-variables). `bootswatch.less` introduces more extensive structural changes.
Copyright and License
----
Copyright 2014 Thomas Park
These files are also available in SASS.
Code released under the MIT License.
Check out the [Help page](http://bootswatch.com/help/) for more details on building your own theme.
Icon
------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment