Skip to content

Commit

Permalink
Merge pull request #14 from mblode/2.0
Browse files Browse the repository at this point in the history
2.0
  • Loading branch information
mblode committed Apr 6, 2016
2 parents 5ef9b1c + 139454b commit 5ccbf42
Show file tree
Hide file tree
Showing 31 changed files with 1,738 additions and 1,304 deletions.
13 changes: 13 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.DS_Store
**/.*
node_modules
bower_components
test
tests
public
gulpfile.js
_site
_sass
_posts
index.html
components
36 changes: 0 additions & 36 deletions .stylintrc

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2015 Matthew Blode
Copyright (c) 2016 Matthew Blode

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
47 changes: 16 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Marx
#### The stylish CSS reset.
#### The classless CSS reset (perfect for Communists).

> No JavaScript. No Classes. Just raw *CSS.*
Expand All @@ -8,11 +8,11 @@ Marx is a CSS stylesheet to be used in any projects (namely small ones). If you

##Key features
- Built atop of Sanitize.css, meaning all browsers render consistently.
- Created using the SASS/Stylus preprocessors (Customise all the variables!).
- Created using the SASS preprocessors (Customise all the variables!).
- Responsive and mobile-friendly.
- Clean, beautiful typography.
- Forms, tables, buttons and navigation.
- Zero classes so it already works with your HTML.
- Zero classes, so it already works with your HTML.
- Drop-dead gorgeous.
- It just works.

Expand All @@ -21,7 +21,8 @@ Marx is a CSS stylesheet to be used in any projects (namely small ones). If you
## Quick Start
Several quick start options are available:

- Install with [Bower](http://bower.io): `bower install marx` (recommended).
- Install with [NPM](https://www.npmjs.com/): `npm install marx` (recommended).
- Install with [Bower](http://bower.io): `bower install marx`.
- Use the latest Marx CDN
```
<!-- Latest compiled and minified CSS -->
Expand All @@ -39,9 +40,6 @@ if you have cloned the repo or downloaded from .zip, there are a few steps you m
4. To run gulp server: `gulp`.
5. To run build process: `gulp build`.

> Optional:
To run server or build using Stylus instead of SASS, then try `gulp stylus` and `gulp build styus`, respectively.

## Running Github Pages
The gh-pages branch is built using Jekyll and must therefore be install with `gem install jekyll`.

Expand All @@ -50,41 +48,28 @@ The gh-pages branch is built using Jekyll and must therefore be install with `ge
3. Run jekyll: `jekyll serve`.
4. Open in browser: `localhost:4000/marx/`.


## What's Included
These are the files that are generated from `bower install marx`

```
.
├── README.md
├── LICENSE.md
├── bower.json
├── package.json
├── css
│   ├── marx.css
│   ├── marx.css.map
│   ├── marx.min.css
│   └── marx.min.css.map
└── scss
│ ├── _buttons.scss
│ ├── _config.scss
│ ├── _forms.scss
│ ├── _html.scss
│ ├── _navigation.scss
│ ├── _sanitize.scss
│ ├── _tables.scss
│ ├── _typography.scss
│ ├── _variables.scss
│ └── marx.scss
└── styl
├── _buttons.styl
├── _config.styl
├── _forms.styl
├── _html.styl
├── _navigation.styl
├── _sanitize.styl
├── _tables.styl
├── _typography.styl
├── _variables.styl
└── marx.styl
├── _base.scss
├── _buttons.scss
├── _forms.scss
├── _sanitize.scss
├── _tables.scss
├── _typography.scss
├── _variables.scss
└── marx.scss
```

## Documentation
Expand Down
5 changes: 2 additions & 3 deletions bower.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "marx",
"version": "1.3.0",
"version": "2.0.0",
"homepage": "https://github.com/mblode/marx",
"authors": [
"mblode <m.blode@gmail.com>"
],
"description": "The stylish CSS reset.",
"description": "The classless CSS reset (perfect for Communists).",
"main": [
"css/*.css",
"scss/*.scss"
Expand Down Expand Up @@ -38,7 +38,6 @@
"test",
"tests",
"gulpfile.js",
"package.json",
"_site",
"_sass",
"_posts",
Expand Down

0 comments on commit 5ccbf42

Please sign in to comment.