feat: added readme template

README.md

@@ -0,0 +1,199 @@
+[![Starware](https://img.shields.io/badge/Starware-⭐-black?labelColor=f9b00d)](https://github.com/zepfietje/starware)
+
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+
+[![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors-)
+
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+
+<br />
+<p align="center">
+  <a href="https://github.com/OpencodeNIT-R/Project-Athena">
+    <img src="images/logo.png" alt="Logo" width="130">
+  </a>
+
+  <h3 align="center">OpenCode</h3>
+
+  <p align="center">
+    The official repository for the website of OpenCode    <br />
+    <br />
+    <a href="#">View Live</a>
+    ·
+    <a href="https://github.com/OpencodeNIT-R/Project-Athena/issues">Report Bugs</a>
+    .
+    <a href="https://github.com/OpencodeNIT-R/Project-Athena/issues">Add Features</a>
+  </p>
+</p>
+
+<!-- TABLE OF CONTENTS -->
+<details open="open">
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+      </ul>
+        <li><a href="#built-with">Built With</a></li>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#contribution-guidlines">Contribution guidlines</a></li>
+        <li><a href="#local-repository-setup">Local Repository Setup</a></li>
+        <li><a href="#running-the-project">Running the project</a></li>
+      </ul>
+    </li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#OPENCODE NITR">OpenCode NITR</a></li>
+    <li><a href="#starware">Starware</a></li>
+    <li><a href="#contributors">Contributors</a></li>
+  </ol>
+</details>
+
+## About The Project
+
+OpenCode Website
+
+## Built With
+
+Following technologies and libraries are used for the development of this website
+
+- [Next]()
+- [Tailwind]()
+- [Netlify]()
+
+## Getting Started
+
+To setup the project locally the steps below.
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org/en/download/)
+
+  ```sh
+  # Homebrew
+  brew install nodejs
+
+  # Sudo apt
+  sudo apt install nodejs
+
+  # Packman
+  pacman -S nodejs
+
+  # Module Install
+  dnf module install nodejs:<stream> # stream is the version
+
+  # Windows (chocolaty)
+  cinst nodejs.install
+
+  ```
+
+- [Yarn](https://classic.yarnpkg.com/en/docs/install/)
+
+```sh
+  npm install --global yarn
+```
+
+- [Git](https://git-scm.com/downloads)
+
+```sh
+  # Homebrew
+  brew install git
+
+  # Sudo apt
+  apt-get install git
+
+  # Packman
+  pacman -S git
+
+  # Module Install (Fedora)
+  dnf install git
+
+```
+
+### Contribution guidlines 😎
+
+---
+
+Our Slack Community: [Slack Invite](http://bit.ly/NITRDevs) <br>
+
+`Contributions are welcome 🙌🏻🙌🏻`
+
+### Local Repository Setup
+
+Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.
+
+1.  **Fork** the repo on GitHub
+2.  **Clone** the project to your local system
+3.  **Commit** changes to your own separate branch
+4.  **Push** your work back up to your fork
+5.  Submit a **Pull request** so that we can review your changes
+
+NOTE 1: Please abide by the [Contributing Guidelines](https://github.com/OpencodeNIT-R/project-athena/blob/master/CONTRIBUTING.md).
+
+NOTE 2: Please abide by the [Code of Conduct](https://github.com/OpencodeNIT-R/project-athena/blob/master/CODE_OF_CONDUCT.md).
+
+### Running the project.
+
+The project uses Yarn and not NPM. It is strictly advised to stick with Yarn so as to avoid dependency conflicts down the line.
+
+```
+## Checkout into the project client directory
+cd client
+
+## Install Dependencies
+yarn install
+
+## Run the Project
+yarn develop
+
+```
+
+Following are the commands to remove/add new dependencies using yarn
+
+```
+## Add a new Package
+yarn add package_name
+
+## Remove an existing Package
+yarn remove package_name
+
+## Save Package as a Dev Dependency
+yarn add -D package_name
+```
+
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+## OPENCODE NITR
+
+[![Opencode NITR][opencode-nitr]]()
+
+## Starware
+
+OpencodeNIT-R/project-athena is Starware.
+This means you're free to use the project, as long as you star its GitHub repository.
+Your appreciation makes us grow and glow up. ⭐
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+
+[contributors-shield]: https://img.shields.io/github/contributors/OpencodeNIT-R/project-athena?style=for-the-badge
+[contributors-url]: https://github.com/OpencodeNIT-R/project-athena/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/OpencodeNIT-R/project-athena?style=for-the-badge
+[forks-url]: https://github.com/OpencodeNIT-R/project-athena/network/members
+[stars-shield]: https://img.shields.io/github/stars/OpencodeNIT-R/project-athena?style=for-the-badge
+[stars-url]: https://github.com/OpencodeNIT-R/project-athena/stargazers
+[issues-shield]: https://img.shields.io/github/issues/OpencodeNIT-R/project-athena?style=for-the-badge
+[issues-url]: https://github.com/OpencodeNIT-R/project-athena/issues
+[license-shield]: https://img.shields.io/github/license/OpencodeNIT-R/project-athena?style=for-the-badge
+[license-url]: https://github.com/OpencodeNIT-R/project-athena/LICENSE
+[Opencode-nitr]: images/logo_plus_wordmark_black.png