README.md 1.89 KB
Newer Older
David Haynes's avatar
David Haynes committed
1
# Masonstrap (GMU bootstrap theme) [![build status](https://git.gmu.edu/srct/masonstrap/badges/master/build.svg)](https://git.gmu.edu/srct/masonstrap/commits/master)
Thomas Park's avatar
Thomas Park committed
2

David Haynes's avatar
David Haynes committed
3
A project of [GMU SRCT](http://srct.gmu.edu).
Thomas Park's avatar
Thomas Park committed
4

David Haynes's avatar
David Haynes committed
5 6
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.
Thomas Park's avatar
Thomas Park committed
7

David Haynes's avatar
David Haynes committed
8 9
## Enabling Masonstrap for Your Project
<legend></legend>
Thomas Park's avatar
Thomas Park committed
10

David Haynes's avatar
David Haynes committed
11
All you need to do is to take _bootstrap.min.css_ and add it to the static files for your project.
Thomas Park's avatar
Thomas Park committed
12

David Haynes's avatar
David Haynes committed
13
Masonstrap bundles bootstrap 3.0 and normalize.css for you.
14

15

David Haynes's avatar
David Haynes committed
16 17
## Making Changes to Masonstrap
<legend></legend>
18

David Haynes's avatar
David Haynes committed
19
If you would like to make changes to values or behaviors in Masonstrap you will need to do some quick setup.
20

David Haynes's avatar
David Haynes committed
21
Ensure node.js is installed:
22

David Haynes's avatar
David Haynes committed
23 24 25
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/).
26

David Haynes's avatar
David Haynes committed
27
and in the root directory of this project (bootswatch/) run:
Thomas Park's avatar
Thomas Park committed
28

David Haynes's avatar
David Haynes committed
29
`$ npm install`
Thomas Park's avatar
Thomas Park committed
30

David Haynes's avatar
David Haynes committed
31
You will also need to have Grunt installed globally on your system:
Thomas Park's avatar
Thomas Park committed
32

David Haynes's avatar
David Haynes committed
33
`$ npm install -g grunt-cli`
34

David Haynes's avatar
David Haynes committed
35
Finally, run:
36

David Haynes's avatar
David Haynes committed
37
`$ grunt watch`
38

David Haynes's avatar
David Haynes committed
39
in order for Grunt to rebuild the bootstrap files.
Thomas Park's avatar
Thomas Park committed
40

David Haynes's avatar
David Haynes committed
41
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.
42

David Haynes's avatar
David Haynes committed
43
Customization
Thomas Park's avatar
Thomas Park committed
44
------
David Haynes's avatar
David Haynes committed
45
Bootswatch is open source and you’re welcome to modify the themes.
Thomas Park's avatar
Thomas Park committed
46

David Haynes's avatar
David Haynes committed
47
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.
Thomas Park's avatar
Thomas Park committed
48

David Haynes's avatar
David Haynes committed
49
These files are also available in SASS.
Thomas Park's avatar
Thomas Park committed
50

David Haynes's avatar
David Haynes committed
51
Check out the [Help page](http://bootswatch.com/help/) for more details on building your own theme.
David Haynes's avatar
David Haynes committed
52 53 54 55

Icon
------
website by Stock Image Folio from the Noun Project