diff --git a/README.md b/README.md index 0455e69..b2711a0 100644 --- a/README.md +++ b/README.md @@ -1,98 +1 @@ -# FireShell [![Build Status](https://travis-ci.org/toddmotto/fireshell.png)](https://travis-ci.org/toddmotto/fireshell) - -Fiercely quick front-end boilerplate and workflows. - -The opinionated FireShell framework. Built for the modern developer. For teams and the individual, encouraging a better workflow. JavaScript task running, build processes, autominification and file concatenation, wrapped with an enhanced HTML5 boilerplated framework. - -* Source: [github.com/toddmotto/fireshell](http://github.com/toddmotto/fireshell) -* Homepage: [getfireshell.com](http://getfireshell.com) -* Twitter: [@getfireshell](http://twitter.com/getfireshell) - -## Jump start - -Get started with FireShell: - -1. Download the latest stable release from - [getfireshell.com](http://getfireshell.com). -2. Clone the git repo — `git clone - https://github.com/toddmotto/fireshell.git` - -## Documentation - -View the developer documentation on FireShell for further reading and learning. - -## Features - -Here are some of the main features of FireShell: - -* HTML5 framework, WAI-ARIA roles and HTML5 semantics -* Baseline HTML5 features, DNS prefetching, responsive meta -* Encourages one-file CSS/JS in the view (HTML) for performance -* Includes jQuery CDN and relative fallback -* Includes Modernizr and HTML5 Shiv -* Google Universal Analytics snippet -* Open source workflow with Grunt.js running on Node.js -* A grunt.command file for double-click command-line execution -* Automatic Grunt dependency installation, directory relocation and grunt tasks -* Dynamically appended copyright for JS/CSS -* Livereloading the browser and file injection upon changes -* Annotated Gruntfile.js for extending -* Built-in build script for auto-minification of CSS and JavaScript files for production -* Pre-setup Sass/SCSS files and folders for baseline project structure and imports -* Includes .editorconfig for consistent coding styles in IDEs -* Standard .gitignore to ignore minified files and standard ignorables such as .DS_Store -* JSHint .jshintrc file for configuring JavaScript linting -* No superfluous code comments -* Extremely lightweight footprint - -## Scaffolding - -```` -├── app -│ ├── css -│ ├── fonts -│ ├── img -│ ├── js -│ ├── favicon.ico -│ └── index.html -├── src -│ ├── js -│ │ └── scripts.js -│ └── scss -│ ├── mixins -│ ├── modules -│ ├── partials -│ ├── vendor -│ └── style.scss -├── docs -├── grunt-build.command -├── grunt-dev.command -├── package.json -├── README.md -├── .editorconfig -├── .gitignore -├── .jshintrc -└── .travis.yml -```` - -## License - -Copyright (c) FireShell - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies -of the Software, and to permit persons to whom the Software is furnished to do -so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +# Clicksco Front End Boilerplate \ No newline at end of file diff --git a/grunt-build.command b/grunt-build.command deleted file mode 100755 index 0ffcca1..0000000 --- a/grunt-build.command +++ /dev/null @@ -1,6 +0,0 @@ -path=`dirname $0` -cd $path -if [ ! -d node_modules ];then - sudo npm install -fi -grunt build diff --git a/grunt-dev.command b/grunt-dev.command deleted file mode 100755 index 581bc9f..0000000 --- a/grunt-dev.command +++ /dev/null @@ -1,6 +0,0 @@ -path=`dirname $0` -cd $path -if [ ! -d node_modules ];then - sudo npm install -fi -grunt