init
This commit is contained in:
42
README.md
Normal file
42
README.md
Normal file
@ -0,0 +1,42 @@
|
||||
## The Stack
|
||||
Grunt based task runner with Assemble.io used to generate prototype html sites.
|
||||
|
||||
## How to use this project
|
||||
Instead of setting up some sort of generator, clone this project and rebuild the git history.
|
||||
|
||||
* `git clone`
|
||||
* `rm -rf .git`
|
||||
* `git init`
|
||||
* `git add -A`
|
||||
* `git commit -m 'init'`
|
||||
|
||||
Then install and start up the runner:
|
||||
|
||||
* `npm install` or `yarn install`
|
||||
* `grunt serve`
|
||||
|
||||
|
||||
## [sass-lint][sass-lint]
|
||||
|
||||
[sass-lint]: https://github.com/sasstools/sass-lint "A Node-only Sass linter for both sass and scss syntax!"
|
||||
|
||||
- .sass-lint.yml
|
||||
- [rules documentation](https://github.com/sasstools/sass-lint/tree/master/docs/rules)
|
||||
- [editor integration](https://github.com/sasstools/sass-lint#ide-integration)
|
||||
|
||||
## [eslint][eslint]
|
||||
|
||||
[eslint]: http://eslint.org/ "The pluggable linting utility for JavaScript and JSX"
|
||||
|
||||
- .eslintrc (can be json or yml. yml is more comment friendly, so preferred)
|
||||
- [rules documentation](http://eslint.org/docs/rules/)
|
||||
- [editor integration](http://eslint.org/docs/user-guide/integrations#editors)
|
||||
|
||||
## Misc Files
|
||||
|
||||
These files are not directly related to the linters, but should be standard in every project.
|
||||
|
||||
- [.editorconfig](http://editorconfig.org/) - [editor plugins](http://editorconfig.org/#download)
|
||||
- .gitignore
|
||||
- .gitattributes
|
||||
|
Reference in New Issue
Block a user