Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
mrmrs committed Sep 27, 2015
1 parent 9629a1e commit 569a72b
Showing 1 changed file with 26 additions and 33 deletions.
59 changes: 26 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,14 @@ Uses gulp to create a dev environment for rapidly prototyping sites.

## Features

* sass compilation
* css compiling with postcss
* css minification
* css linting
* autoprefixer (automatically adds appropriate vendor prefixes)
* browser reload on filesave
* browser reload on filesave using browser-sync
* local server for serving a static site

## Getting started

Watch [this screencast](https://vimeo.com/121332805) on getting mnml setup or
follow the directions below.

### Instructions

* Create a new repo for your project on Github
Expand All @@ -46,32 +42,29 @@ To set up a convenient dev environment run this at the root of mnml
npm install && npm start
```

Gulp is a javascript task runner. It compiles sass, lints the compiled css, and
sets up a browser-sync server so you can save your fingers from pressing ⌘+TAB + ⌘+r
every time you save a file.

* Once you add & commit files you are ready to publish run:
```bash
git push origin master
```

## Directory structure
```
mnml/
├── README.md
├── gulpfile.js
├── package.json
├── index.html
├── css
│ └── mnml.css (10kb / 3.04 gzipped)
│ └── mnml.min.css (2.27 kb minified - 989B gzipped)
└── sass CSS source files
├── _normalize.scss
├── _variables.scss
├── _base.scss
├── _type.scss
├── _styles.scss
└── mnml.scss
mnml/
├── README.md
├── css
│   ├── mnml.css
│   └── mnml.min.css
├── index.html
├── index.js
├── package.json
└── src
├── _base.css
├── _debug.css
├── _grid.css
├── _media-queries.css
├── _styles.css
├── _typography.css
├── _variables.css
├── lib
│   └── _normalize.css
└── mnml.css
```

# Author
Expand All @@ -80,10 +73,10 @@ git push origin master

# Contributors

Xiao (Sean) Wu
Chris Bracco
Andrés Olivares
Amira Hailemariam
Xiao (Sean) Wu
Chris Bracco
Andrés Olivares
Amira Hailemariam

# License

Expand Down

0 comments on commit 569a72b

Please sign in to comment.