From 9cfddd072511da13a4cbd570dabab3d37165a324 Mon Sep 17 00:00:00 2001 From: tjdakf Date: Fri, 10 Oct 2025 19:52:17 +0900 Subject: [PATCH] docs: update readme, license --- LICENSE | 21 +++++++++++++++++++++ README.md | 37 ++++++++++++++++++++++++++++++++++++- 2 files changed, 57 insertions(+), 1 deletion(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7fc24b8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 tjdakf. + +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. diff --git a/README.md b/README.md index f463cf3..8699319 100644 --- a/README.md +++ b/README.md @@ -1 +1,36 @@ -# github-practice +# Github-practice +해당 프로젝트는 Github를 개발자스럽게 사용하기 위한 실습을 포함하고 있습니다. + +## Prerequisites +- Python 3.11 (x86) +- pip + +## Installation +```shell +& pip install -r requirments.txt +``` +## How to use +```python +from main import add + +a = 10 +b = 5 + +answer = add(10, 5) + +print(f"Answer is {answer}") +``` + +## How to test +```shell +$ python tests +``` + +## How to contribute +1. 이 저장소를 포크합니다. +2. 새로운 기능이나 버그 수정과 관련된 브랜치를 만듭니다: git checkout -b feat-{ISSUE TAG}/{BRANCH NAME} +3. 변경 사항을 커밋하고 푸시합니다. +4. Pull Request를 작성하고 메인테이너에게 리뷰를 요청합니다. + +## Licence +이 프로젝트는 MIT 라이선스를 따릅니다. 자세한 내용은 LICENSE 항목을 참조하세요.