Skip to content
This repository was archived by the owner on Apr 24, 2019. It is now read-only.

Commit cd96376

Browse files
committed
Minor updates to README file
1 parent ae356db commit cd96376

File tree

1 file changed

+36
-16
lines changed

1 file changed

+36
-16
lines changed

README.md

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# <img src="http://rawgithub.com/use-init/init/master/logo.svg" alt="INIT" title="INIT" width="200">
22

3-
This project is based upon [HTML5 Boilerplate](https://github.com/h5bp/html5-boilerplate) and adds more structure for SCSS and JavaScript files, includes build tasks and a whole lot more.
3+
This project is based upon
4+
[HTML5 Boilerplate](https://github.com/h5bp/html5-boilerplate) and adds more
5+
structure for SCSS and JavaScript files, includes build tasks and a whole lot
6+
more.
47

58
[![Build Status](https://secure.travis-ci.org/use-init/init.png?branch=master)](http://travis-ci.org/use-init/init)
69
[![Dependency Status](https://david-dm.org/use-init/init.png)](https://david-dm.org/use-init/init)
@@ -20,14 +23,13 @@ Majors:
2023
Secondaries:
2124

2225
* Node: npm
23-
* Ruby: SASS
24-
* Bower
26+
* Ruby: Sass 3.3.x
2527

2628
After you've set this stuff up please run
2729

28-
$ npm install -g grunt-cli
30+
$ npm install -g grunt-cli bower
2931

30-
This installs the Grunt command line tools.
32+
This installs the Grunt command line tools and bower.
3133
Afterwards please run
3234

3335
$ npm install
@@ -42,7 +44,8 @@ managed by Bower.
4244

4345
### Troubleshooting
4446

45-
If running the install does not work, please try running it as with admin-rights:
47+
If running the install does not work, please try running it as with
48+
admin-rights:
4649

4750
$ sudo npm install -g grunt-cli
4851

@@ -57,49 +60,66 @@ If running the install does not work, please try running it as with admin-rights
5760

5861
## Yeoman Generator-INIT
5962

60-
INIT is also available as [Yeoman Generator](http://yeoman.io/generators.html) and is called [`generator-init`](https://github.com/use-init/generator-init). See the repository for detailed instruction and more information.
63+
INIT is also available as [Yeoman Generator](http://yeoman.io/generators.html)
64+
and is called [`generator-init`](https://github.com/use-init/generator-init).
65+
See the repository for detailed instruction and more information.
6166

6267
## Contribute
6368

64-
Please help making this project better and [contribute](CONTRIBUTING.md) with your knowledge.
69+
Please help making this project better and [contribute](CONTRIBUTING.md) with
70+
your knowledge.
6571

6672

6773
## CSS
6874

69-
We are currently working with [Sass](http://sass-lang.com/) (in its dialect SCSS) and do not use CSS directly. Please do not edit the CSS-files in any case but search the corresponding `.scss` file and edit it accordingly. If you are not familiar with SCSS you can write pure CSS which is actually valid SCSS.
75+
We are currently working with [Sass](http://sass-lang.com/) (in its dialect
76+
SCSS) and do not use CSS directly. Please do not edit the CSS-files in any case
77+
but search the corresponding `.scss` file and edit it accordingly. If you are
78+
not familiar with SCSS you can write pure CSS which is actually valid SCSS.
7079

71-
However all `.scss`-files are compiled into one file called `main.css` in the `css`-folder. There is a productive-version (means minified), too.
80+
However all `.scss`-files are compiled into one file called `main.css` in the
81+
`css`-folder. There is a productive-version (means minified), too.
7282

73-
You can find more information about the installation process of Sass and the usage of SCSS in the [Sass Tutorial](http://sass-lang.com/tutorial.html).
83+
You can find more information about the installation process of Sass and the
84+
usage of SCSS in the [Sass Tutorial](http://sass-lang.com/tutorial.html).
7485

7586

7687
## JS
7788

7889
We use jQuery, Modernizr (custom build via Grunt) and RequireJS.
7990

80-
Please use JSHint for your JavaScript before you commit. You can use the Grunt-task `jshint` for this. It is also integrated in `grunt watch`.
91+
Please use JSHint for your JavaScript before you commit. You can use the
92+
Grunt-task `jshint` for this. It is also integrated in `grunt watch`.
8193

8294

8395
## Creating a Build
8496

85-
Please use [Grunt.js](https://github.com/gruntjs/grunt) for building a production-state of a website. The `Gruntfile.js` has tasks for concatenating and minifing CSS and JavaScript.
97+
Please use [Grunt.js](https://github.com/gruntjs/grunt) for building a
98+
production-state of a website. The `Gruntfile.js` has tasks for concatenating
99+
and minifing CSS and JavaScript.
86100

87101
Additional information on this project is stored in `package.json`.
88102

89103

90104
## Development
91105

92-
This package is developed and maintained by [Hans Christian Reinl](http://drublic.de/), [Anselm Hannemann](http://helloanselm.com/) and [more contributors](https://github.com/use-init/init/graphs/contributors).
106+
This package is developed and maintained by
107+
[Hans Christian Reinl](http://drublic.de/),
108+
[Anselm Hannemann](http://helloanselm.com/) and
109+
[more contributors](https://github.com/use-init/init/graphs/contributors).
93110

94111

95112
## Credits
96113

97-
The INIT logo was designed by Jan von Beckerath at [NIMIUS](http://nimius.net) and optimized by [Stefan Nitzsche](http://www.stn.my/).
114+
The INIT logo was designed by Jan von Beckerath at [NIMIUS](http://nimius.net)
115+
and optimized by [Stefan Nitzsche](http://www.stn.my/).
98116

99117

100118
## License
101119

102-
Please be aware of the licenses of each component we use in this project. Everything else that has been developed by the contributions to this project is under [MIT License](LICENSE.md).
120+
Please be aware of the licenses of each component we use in this project.
121+
Everything else that has been developed by the contributions to this project is
122+
under [MIT License](LICENSE.md).
103123

104124

105125
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/use-init/init/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

0 commit comments

Comments
 (0)