[#9] docs: add README

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+## KHUMON Education contributing guide
+Thank you for your interest in contributing to our project! This guide will provide you with an overview of the contribution workflow, from opening an issue to creating a pull request (PR), reviewing, and merging the PR.
+
+## Guide for New Contributors
+To gain a better understanding of the project, please read the [README](https://github.com/FacerAin/khugpt-agent).
+It contains valuable information on how to start making open-source contributions.
+
+## Getting Started
+### Issues
+
+#### Creating a New Issue
+Before creating a new issue, please search to check if a similar issue already exists. If you can't find a related issue, you can open a new one using the appropriate [issue form](https://github.com/FacerAin/khugpt-agent/issues/new/choose).
+#### Resolving an Issue
+Feel free to browse through our existing issues to find one that aligns with your interests. You can utilize labels as filters to narrow down your search. For more details, refer to the Labels section. Typically, we don't assign issues to specific individuals. If you identify an issue you'd like to address, you're welcome to open a PR with your proposed fix.
+### Making Changes
+1. Fork the repository.
+2. Install or update dependency such as Node.js. For more information, see [README](https://github.com/FacerAin/khugpt-agent).
+3. Create a working branch and start with your changes! (eg. feat/nodestyle)
+4. Test your code using prepared test code or you can add additional test code.
+5. Commit your updates.
+### Submitting a Pull Request (PR)
+Once you've completed your changes, it's time to create a pull request (PR):
+- Pull requests for developed changes should be directed towards the `dev` branch.
+- Don't forget to link PR to issue if you are solving one.
+- Once you submit your PR, team member will review your proposal. We may ask questions or request additional information.
+- Once the review is complete, the changes will be automatically merged into the `dev` branch.
+### Your  PR is merged!
+Congratulations! 🎉🎉 Thank you for contributing to our project! Your efforts are greatly appreciated. ☺️
+
+## Reference
+- https://github.com/github/docs/blob/main/CONTRIBUTING.md

README.md

@@ -1,2 +1,171 @@
-# khugpt-agent
-Agent system for KHUGPT service.
+<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
+<a name="readme-top"></a>
+[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![Pull Request][pr-shield]][pr-url] [![MIT License][license-shield]][license-url]
+
+
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/FacerAin/khugpt-agent">
+    <img src="./static/logo.png" alt="Logo" width="200" height="200">
+  </a>
+
+<h3 align="center">KHUGPT Agent Engine</h3>
+
+  <p align="center">
+  API Engine for KHUGPT agent using LLM.
+    <br />
+    <a href="http://facerain-dev.iptime.org:1009/redoc"><strong>Explore the API docs »</strong></a>
+    <br />
+    <br />
+    <br />
+    <br />
+    <a href="https://github.com/FacerAin/khugpt-agent/issues">Report Issues</a>
+    ·
+    <a href="https://github.com/FacerAin/khugpt-agent/pulls">Pull Requests</a>
+  </p>
+</div>
+
+
+### :card_file_box: Built With
+#### :bulb: Language
+[![Python][Python]][Python-url]
+#### :bulb: Frameworks
+[![Fastapi][Fastapi]][Fastapi-url]
+
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- GETTING STARTED -->
+## :rocket: Getting Started
+
+### :zap: Prerequisites
+- [python v3.8+](https://www.python.org/)
+
+### 🚀 Guideline
+
+I recommend building your environment on top of a **virtual environment** (e.g., venv, anaconda, etc.)
+* **Setup**
+
+  ```sh
+  make setup
+  ```
+* **Run application**
+
+  ```sh
+  uvicorn app.main:app
+  ```
+* **Linting & Testing**
+
+  ```sh
+  # Linting
+  make style
+
+  # Testing
+  make test
+  ```
+* **Dockerizing**
+
+  ```sh
+  docker build -t nickname/imagename .
+  ```
+
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+
+
+## :globe_with_meridians: Features
+- **Summarize and quiz** lecture notes or videos.
+- You can input text, PDF, or video.
+- For more information, please refer to the [API documentation](http://facerain-dev.iptime.org:1009/redoc).
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- CONTRIBUTING -->
+## :fire: Contributing
+Please refer to [CONTRIBUTING.md](https://github.com/FacerAin/khugpt-agent/blob/main/CONTRIBUTING.md) for Contribution.
+
+For issues, new functions and requests to modify please follow the following procedure. 🥰
+
+1. Fork the Project
+2. Create a Issue when you have new feature or bug, just not Typo fix
+3. Create your Feature Branch from dev Branch (`git checkout -b feat/Newfeature`)
+4. Commit your Changes (`git commit -m 'feat: add new feature'`)
+5. Push to the Branch (`git push origin feat/Newfeature`)
+6. Open a Pull Request to dev branch with Issues
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- LICENSE -->
+## :closed_lock_with_key: License
+Please refer to `LICENSE` for LICENSE.
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- CONTACT -->
+## :speech_balloon: Contact
+
+<table>
+  <tbody>
+    <tr>
+      <td align="center"><a href="https://github.com/FacerAin"><img src="https://avatars.githubusercontent.com/u/16442978?v=4" width="100px;" alt=""/><br /><sub><b>Yongwoo Song</b></sub></a></td>
+    </tr>
+  </tobdy>
+</table>
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/FacerAin/khugpt-agent.svg?style=flat
+[contributors-url]: https://github.com/FacerAin/khugpt-agent/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/FacerAin/khugpt-agent.svg?style=flat
+[forks-url]: https://github.com/FacerAin/khugpt-agent/network/members
+[stars-shield]: https://img.shields.io/github/stars/FacerAin/khugpt-agent.svg?style=flat
+[stars-url]: https://github.com/FacerAin/khugpt-agent/stargazers
+[issues-shield]: https://img.shields.io/github/issues/FacerAin/khugpt-agent.svg?style=flat
+[issues-url]: https://github.com/FacerAin/khugpt-agent/issues
+[pr-url]: https://github.com/FacerAin/khugpt-agent/pulls
+[pr-shield]: https://img.shields.io/github/issues-pr/FacerAin/khugpt-agent.svg?style=flat
+[license-shield]: https://img.shields.io/github/license/FacerAin/khugpt-agent.svg?style=flat
+[license-url]: https://github.com/FacerAin/khugpt-agent/blob/master/LICENSE.txt
+
+[Python]: https://img.shields.io/badge/Python-14354C?style=for-the-badge&logo=python&logoColor=white
+[Python-url]: https://www.python.org/
+
+[Fastapi]: https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi
+[Fastapi-url]: https://fastapi.tiangolo.com/ko/
+
+
+[Yarn]: https://img.shields.io/badge/yarn-%232C8EBB.svg?style=flat&logo=yarn&logoColor=white
+[Yarn-url]: https://yarnpkg.com/
+[ESLint]: https://img.shields.io/badge/ESLint-4B3263?style=flat&logo=eslint&logoColor=white
+[ESLint-url]: https://eslint.org/
+[Vue]: https://img.shields.io/badge/Vue.js-35495E?style=flat&logo=vuedotjs&logoColor=white
+[Vue-url]: https://vuejs.org/
+[Go]: https://img.shields.io/badge/Go-00ADD8?style=flat&logo=Go&logoColor=white
+[Go-url]: https://go.dev/
+[Terraform]: https://img.shields.io/badge/Terraform-430098?style=flat&logo=Terraform&logoColor=white
+[Terraform-url]: https://www.terraform.io/
+[aws]: https://img.shields.io/badge/AmazonAWS-232F3E?style=flat&logo=AmazonAWS&logoColor=white
+[aws-url]: https://aws.amazon.com/
+[OCI]: https://img.shields.io/badge/Oracle-F80000?style=flat&logo=oracle&logoColor=black
+[OCI-url]: https://www.oracle.com/kr/cloud/
+[Kubernetes]: https://img.shields.io/badge/Kubernetes-326CE5?style=flat&logo=Kubernetes&logoColor=white
+[Kubernetes-url]: https://kubernetes.io/ko/
+[Github-actions]: https://img.shields.io/badge/GitHub_Actions-2088FF?style=flat&logo=github-actions&logoColor=white
+[Github-actions-url]: https://github.com/features/actions
+[Helm]: https://img.shields.io/badge/Helm-326CE5?style=flat&logo=Helm&logoColor=white
+[Helm-url]: https://helm.sh/
+[Accordian]: https://img.shields.io/badge/Accordian-430098?style=flat&logo=Accordian&logoColor=white
+[Accordian-url]: https://accordions.co.kr/