License and readme

.vscode/settings.json

@@ -55,5 +55,7 @@
         "xtr1common": "cpp",
         "xtree": "cpp",
         "xutility": "cpp"
-    }
+    },
+    "license.author": "Shubham Kamble",
+    "license.year": "2020"
 }

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Shubham Kamble
+
+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.

README.md

@@ -0,0 +1,98 @@
+<div align="center" id="top"> 
+  <img src="./.github/brick_buster_demo.gif" alt="BrickBuster" />
+
+  &#xa0;
+
+  <!-- <a href="https://brickbuster.netlify.app">Demo</a> -->
+</div>
+
+<h1 align="center">Brick Buster</h1>
+
+<p align="center">
+  <img alt="Github top language" src="https://img.shields.io/github/languages/top/ufrshubham/brickbuster?color=56BEB8">
+
+  <img alt="Github language count" src="https://img.shields.io/github/languages/count/ufrshubham/brickbuster?color=56BEB8">
+
+  <img alt="Repository size" src="https://img.shields.io/github/repo-size/ufrshubham/brickbuster?color=56BEB8">
+
+  <img alt="License" src="https://img.shields.io/github/license/ufrshubham/brickbuster?color=56BEB8">
+
+  <img alt="Github issues" src="https://img.shields.io/github/issues/ufrshubham/brickbuster?color=56BEB8" />
+
+  <img alt="Github forks" src="https://img.shields.io/github/forks/ufrshubham/brickbuster?color=56BEB8" />
+
+  <img alt="Github stars" src="https://img.shields.io/github/stars/ufrshubham/brickbuster?color=56BEB8" />
+</p>
+
+<!-- Status -->
+
+<h4 align="center"> 
+	🚧  BrickBuster 🚀 Under construction...  🚧
+</h4> 
+
+<hr>
+
+<p align="center">
+  <a href="#dart-about">About</a> &#xa0; | &#xa0; 
+  <a href="#rocket-technologies">Dependencies</a> &#xa0; | &#xa0;
+  <a href="#white_check_mark-requirements">Requirements</a> &#xa0; | &#xa0;
+  <a href="#checkered_flag-starting">Starting</a> &#xa0; | &#xa0;
+  <a href="#memo-license">License</a> &#xa0; | &#xa0;
+  <a href="https://github.com/ufrshubham" target="_blank">Author</a>
+</p>
+
+<br>
+
+## :dart: About ##
+
+I always wanted to lean and understand how to use Box2D for game physics and [CWF: Fall 2020](https://codewithfriends.io/) seemed like the perfect opportunity to start a casual game project to get some hands-on with Box2D. So I started working on this simple break out game called brick buster.
+
+Check [releases](https://github.com/ufrshubham/Brick-Buster/releases) section to get playable executable (currently only avaliable for Windows and Linux). 
+
+## :rocket: Dependencies ##
+
+The following tools were used in this project:
+
+- [SFML](https://www.sfml-dev.org/)
+- [Box2D](https://box2d.org/)
+
+## :white_check_mark: Requirements ##
+
+Before starting :checkered_flag:, you need to have 
+- Git
+- C++ compiler
+- Cmake
+- Pre-build static libraries for SFML and Box2D
+
+## :checkered_flag: Starting ##
+
+```bash
+# Clone this project
+$ git clone https://github.com/ufrshubham/Brick-Buster.git
+
+# Enter project directory
+$ cd Brick-Buster
+
+```
+
+- Build or download SFML and Box2D libraries for your platform.
+
+- Place release SFML libraries in vendor/sfml/lib/release and debug libraries in vendor/sfml/lib/debug.
+
+- Similarly place relase and debug libraries for Box2D under vendor/box2d/lib/release and vendor/box2d/lib/debug.
+
+``` bash
+# Generate projects files
+$ mkdir build
+$ cd build
+$ cmake ..
+```
+
+- This will generate project files for appropriate IDE for your platform. Proceed with standard build process by opening project files.
+
+## :memo: License ##
+
+This project is under license from MIT. For more details, see the [LICENSE](LICENSE) file.
+
+
+<a href="#top">Back to top</a>