Commit 06aec832 authored by David Haynes's avatar David Haynes

Update README documentation to v4

- Better .md formatting as well!
parent a9894d29
Pipeline #1058 passed with stage
in 57 seconds
# Masonstrap (GMU bootstrap theme) [![build status](https://git.gmu.edu/srct/masonstrap/badges/master/build.svg)](https://git.gmu.edu/srct/masonstrap/commits/master)
V4 INSTRUCTIONS
- `npm install`
- `bower install`
- `sudo apt install ruby`
- `sudu gem install sass`
- `grunt swatch`
- `grunt` - opens live preview site
A project of [GMU SRCT](http://srct.gmu.edu).
Masonstrap is a custom theme for bootstrap customized with GMU brand colors and
Masonstrap is a theme for bootstrap customized with GMU brand colors and
elements. It aims to easily provide any web project with Mason branding.
## Enabling Masonstrap for Your Project
<legend></legend>
# Adding Masonstrap to your project
This repo contains all of the necessary components to build and modify masonstrap
on your local machine. If you'd like just `masonstrap.min.css` head over to our
......@@ -25,57 +13,63 @@ on your local machine. If you'd like just `masonstrap.min.css` head over to our
latest build of the css.
Additionally this link should grab you the latest css build:
https://git.gmu.edu/srct/masonstrap/builds/artifacts/master/download?job=build_css
[https://git.gmu.edu/srct/masonstrap/builds/artifacts/master/download?job=build_css]()
Masonstrap bundles bootstrap 3.7 and normalize.css for you.
## Building Masonstrap
<legend></legend>
# Building Masonstrap
If you would like to make changes to values or behaviors in Masonstrap you will
need to do some quick setup.
1. Ensure node.js is installed:
On Ubuntu: `$ sudo apt-get install npm`
On Ubuntu:
sudo apt update
sudo apt install nodejs
sudo apt install npm
On macOS, make sure you have [Homebrew](http://brew.sh) then `$ brew install node`
On macOS:
1. make sure you have [Homebrew](http://brew.sh)
2. `brew install node`
On Windows, download it [here](https://nodejs.org/en/download/).
2. In the root directory of this project run:
2. You will also need Sass which is distributed as a ruby gem:
`$ npm install`
On Ubuntu:
3. You will also need to have Grunt installed globally on your system:
sudo apt update
sudo apt install ruby
sudo gem install sass
`$ npm install -g grunt-cli`
3. In the root directory of this project run:
4. Finally, run:
npm install
bower install
`$ grunt swatch:masonstrap` to build masonstrap.css and masonstrap.min.css.
4. Finally, run:
### Stylesheet test webpage
grunt build
Run:
to build the css files (`masonstrap.css` and `masonstrap.min.css`) in the `masonstrap/` directory.
`grunt`
# Local development
to spin up a local server at [http://0.0.0.0:3000](http://0.0.0.0:3000) that
will host a test webpage displaying all of the masonstrap elements styled with
your locally built css files. It will also rebuild masonstrap when it detects
that changes have been made and livereload the page for you.
If you would like to run the demo site on your local machine run:
## Making changes to Masonstrap
grunt
Masonstrap 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.
This will spin up a local server at [127.0.0.1:3000]().
These files are also available in SASS.
Any changes made to the `.scss` or `.html` files will trigger a rebuild of the css and livereload of the site.
## Making changes to Masonstrap
Icon
------
website by Stock Image Folio from the Noun Project
Masonstrap consists of two Sass files. `_variables.scss`, which is included by
default in Bootstrap, allows you to customize [these settings](http://getbootstrap.com/customize/#less-variables).
`_masonstrap.scss` introduces more extensive structural changes.
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