Create README.md

Author: SuyashLakhotia

README.md

@@ -0,0 +1,66 @@
+# Bootstrap Cards
+— *Bootstrap template implementing card-based design.*
+
+## How to Install
+
+### Default *Bootstrap Cards*
+
+1. Download this repo.
+2. Navigate to the `dist/` folder on Terminal.
+3. Install all the Bower dependencies using `bower install`.
+4. Copy the contents of `dist/` to your project folder.
+
+### Customising *Bootstrap Cards*
+
+#### Setup
+
+1. Download this repo.
+2. Install Gulp globally using `npm install -g gulp-cli`.
+3. Install the Node.js modules needed in this project using `npm install`.
+4. Navigate to `dist/` and install all the Bower dependencies using `bower install`.
+
+#### Writing Code
+
+1. Navigate to this repo and run `gulp`. This will serve the files in `dist/` through a local web server and take care of JS linting, Sass compilation and refreshing the browser when any changes are made.
+2. To change the CSS, edit the Sass code inside `src/sass/`.
+3. To change the JS, edit the JS code inside `src/js/`.
+
+#### Contents of Source Folder & Gulp Tasks
+```
+| - src/
+|   | - img/
+|   | - js/
+|   | - sass/
+|   |   | - layout/
+|   |   | - pages/
+|   |   | - utils/
+|   |   | - main.scss
+|   | - index.html
+```
+
+- `src/img/`: Contains all images. Gulp copies them over to `dist/img/`.
+- `src/js/`: Contains all custom JavaScript files. Gulp lints them and then copies them over to `dist/js/`.
+- `src/sass/`: Contains all custom styles. Gulp lints them and then compiles `main.scss` into `dist/css/cards.css`.
+- `src/*.html`: Gulp copies them over to `dist/`.
+
+##### Sass Files
+- `sass/layout/`: Contains styles for the navbar and footer.
+- `sass/pages/`: Contains page-specific styles.
+- `sass/utils/`: Contains globally used variables, mixins & styles.
+- `sass/main.scss`: Imports all the necessary Sass files.
+
+## Bower Components
+
+Listed below are all the Bower components used in *Bootstrap Cards*. The ones in **bold** are necessary while the others are optional.
+
+- **Normalize.css** ([https://necolas.github.io/normalize.css/](https://necolas.github.io/normalize.css/))
+- **jQuery** ([https://jquery.com/](https://jquery.com/))
+- **Bootstrap** ([http://getbootstrap.com/](http://getbootstrap.com/))
+- Font Awesome ([http://fontawesome.io/](http://fontawesome.io/))
+- Animate.css ([https://daneden.github.io/animate.css/](https://daneden.github.io/animate.css/))
+- wow.js ([http://mynameismatthieu.com/WOW/](http://mynameismatthieu.com/WOW/))
+- jQuery Easing Plugin ([https://github.com/gdsmith/jquery.easing](https://github.com/gdsmith/jquery.easing))
+
+## To-Do
+- [ ] Main Blog Page
+- [ ] Blog Post Page