Skip to content

Commit b114419

Browse files
authored
Update README.md
1 parent febe95b commit b114419

File tree

1 file changed

+39
-17
lines changed

1 file changed

+39
-17
lines changed

README.md

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Marx is a CSS stylesheet to be used in any projects (namely small ones). If you
1414
## Key features
1515

1616
- Built atop of Sanitize.css, meaning all browsers render consistently.
17-
- Created using the SASS preprocessors (Customise all the variables!).
17+
- Created using SASS and Stylus preprocessors (Customise all the variables!).
1818
- Responsive and mobile-friendly.
1919
- Clean, beautiful typography.
2020
- Forms, tables, buttons and navigation.
@@ -32,9 +32,12 @@ Several quick start options are available:
3232
- Install with [NPM](https://www.npmjs.com/): `npm install marx-css` (recommended).
3333
- Install with [Bower](http://bower.io): `bower install marx`.
3434
- Use the latest Marx CDN
35-
```
35+
36+
``` html
37+
3638
<!-- Latest compiled and minified CSS -->
3739
<link rel="stylesheet" href="https://cdn.rawgit.com/mblode/marx/master/css/marx.min.css">
40+
3841
```
3942
- [Source code.](https://raw.githubusercontent.com/mblode/marx/master/css/marx.min.css)
4043
- [Download the latest release](https://github.com/mblode/marx/archive/master.zip).
@@ -53,31 +56,48 @@ The gh-pages branch is built using Jekyll and must therefore be install with `ge
5356

5457
1. Checkout in to gh-pages: `git checkout gh-pages`.
5558
2. Install marx dependency: `bower install`.
56-
3. Run middleman: `middleman serve`.
59+
3. Run middleman: `bundle exec middleman serve`.
5760
4. Open in browser: `localhost:4567`.
5861

5962
## What's Included
6063

61-
These are the files that are generated from `bower install marx`
64+
These are the files that are generated from `npm install marx-css`
6265

6366
```
67+
6468
.
65-
├── README.md
6669
├── LICENSE.md
70+
├── README.md
6771
├── bower.json
68-
├── package.json
6972
├── css
70-
│   ├── marx.css
71-
│   ├── marx.min.css
72-
└── scss
73-
├── _base.scss
74-
├── _buttons.scss
75-
├── _forms.scss
76-
├── _sanitize.scss
77-
├── _tables.scss
78-
├── _typography.scss
79-
├── _variables.scss
80-
└── marx.scss
73+
│ ├── marx.css
74+
│ ├── marx.min.css
75+
│ ├── marx.min.css.map
76+
│ ├── marx.styl.css
77+
│ ├── marx.styl.min.css
78+
│ └── marx.styl.min.css.map
79+
├── gulpfile.js
80+
├── index-stylus.html
81+
├── index.html
82+
├── package.json
83+
├── scss
84+
│ ├── _base.scss
85+
│ ├── _buttons.scss
86+
│ ├── _form.scss
87+
│ ├── _tables.scss
88+
│ ├── _typography.scss
89+
│ ├── _variables.scss
90+
│ └── marx.scss
91+
└── styl
92+
├── _base.styl
93+
├── _buttons.styl
94+
├── _form.styl
95+
├── _sanitize.styl
96+
├── _tables.styl
97+
├── _typography.styl
98+
├── _variables.styl
99+
└── marx.styl
100+
81101
82102
```
83103

@@ -86,6 +106,7 @@ These are the files that are generated from `bower install marx`
86106
### Basic HTML Template
87107

88108
```html
109+
89110
<!DOCTYPE html>
90111
<html lang="en">
91112
<head>
@@ -135,6 +156,7 @@ These are the files that are generated from `bower install marx`
135156

136157
</body>
137158
</html>
159+
138160
```
139161

140162
## Contributing to Marx

0 commit comments

Comments
 (0)