Skip to content

Commit

Permalink
feat: fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
elecbug committed Sep 12, 2024
1 parent 35335ea commit 48095e1
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 36 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Update README

on:
push:
branches:
- master
workflow_dispatch:

jobs:
update-readme:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '20'

- name: Combine readme-base.md and version into README.md
run: |
rm README.md
echo -e "$(cat readme-base.md)$(cat version)" > README.md
- name: Commit and push changes
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
git add README.md
git commit -m "Update README.md with version"
git push
File renamed without changes.
36 changes: 0 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +0,0 @@
# Welcome Git

- 컴퓨터 공학 초심자를 위한 Git 시스템 설명 문서
- Document that explain Git system for junior Computer S&E students

## 설명서

- 보통 `[YOUR_NAME]`같은 "[]" 사이에 있는 내용은 해당 변수를 입력하라는 의미로 쓰인 것입니다. 가령 닉네임을 `hello`로 생성하고, `https://github.com/[YOUR_NAME]``https://github.com/hello`로 바꾸라는 의미입니다.

## FAQ

- 윈도우인데 잘 안돼요.
- 본 설명은 리눅스 사용을 가정하고 쓰였습니다. 데스크탑에 간단히 WSL로 우분투를 설치 하실 수 있고, 아니면 ChatGPT한테 복붙하고 윈도우용으로 바꿔달라고 하면 바꿔줍니다.
- 또한 명령 프롬프트(cmd) 말고 가급적 Windows PowerShell을 사용하시면 좀 더 원활히 진행하실 수 있습니다.

## 구성

|Course|Title|Description|Go|
|------|-----|-----------|--|
|# 01|What is Git?|Git이 무엇인지 알아보고, 기본적인 Git command에 대해 학습한다.|[Link](./C01/README.md)|
|# 02|Using GitHub|앞서 배운 Git의 기초를 토대로 GitHub 서비스를 이용한다.|[Link](./C02/README.md)|
|# 03|Merge conflict|Git merge에 대해 이해하고, 충돌을 해결한다.|[Link](./C03/README.md)|
|# Special 1|Git ignore|Git ignore 파일에 대해 학습한다.|[Link](./S1/READMD.md)
|# 04|Fork and PR|Fork와 PR에 대해 이해하고, 진정한 의미의 협업을 배운다.|[Link](./C04/README.md)|

## 이하 기타 사항

1. 본 문서는 한국어를 사용하여 작성되어 있으며, 본 문서의 번역에 관심이 있으신 분은 [아래 이메일](mailto:deveb1479@gmail.com)로 문의 바랍니다.
2. 본 문서의 수정 사항 및 오류 등에 대한 문의는 Pull request 및 Issue 기능을 활용하여 주시기 바랍니다.

## Maintainer Information

Email: deveb1479@gmail.com

## Version Info.
v0.4.2
36 changes: 36 additions & 0 deletions readme-base.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Welcome Git

- 컴퓨터 공학 초심자를 위한 Git 시스템 설명 문서
- Document that explain Git system for junior Computer S&E students

## 설명서

- 보통 `[YOUR_NAME]`같은 "[]" 사이에 있는 내용은 해당 변수를 입력하라는 의미로 쓰인 것입니다. 가령 닉네임을 `hello`로 생성하고, `https://github.com/[YOUR_NAME]``https://github.com/hello`로 바꾸라는 의미입니다.

## FAQ

- 윈도우인데 잘 안돼요.
- 본 설명은 리눅스 사용을 가정하고 쓰였습니다. 데스크탑에 간단히 WSL로 우분투를 설치 하실 수 있고, 아니면 ChatGPT한테 복붙하고 윈도우용으로 바꿔달라고 하면 바꿔줍니다.
- 또한 명령 프롬프트(cmd) 말고 가급적 Windows PowerShell을 사용하시면 좀 더 원활히 진행하실 수 있습니다.

## 구성

|Course|Title|Description|Go|
|------|-----|-----------|--|
|# 01|What is Git?|Git이 무엇인지 알아보고, 기본적인 Git command에 대해 학습한다.|[Link](./C01/README.md)|
|# 02|Using GitHub|앞서 배운 Git의 기초를 토대로 GitHub 서비스를 이용한다.|[Link](./C02/README.md)|
|# 03|Merge conflict|Git merge에 대해 이해하고, 충돌을 해결한다.|[Link](./C03/README.md)|
|# Special 1|Git ignore|Git ignore 파일에 대해 학습한다.|[Link](./S1/READMD.md)
|# 04|Fork and PR|Fork와 PR에 대해 이해하고, 진정한 의미의 협업을 배운다.|[Link](./C04/README.md)|

## 이하 기타 사항

1. 본 문서는 한국어를 사용하여 작성되어 있으며, 본 문서의 번역에 관심이 있으신 분은 [아래 이메일](mailto:deveb1479@gmail.com)로 문의 바랍니다.
2. 본 문서의 수정 사항 및 오류 등에 대한 문의는 Pull request 및 Issue 기능을 활용하여 주시기 바랍니다.

## Maintainer Information

Email: deveb1479@gmail.com

## Version Info.

1 change: 1 addition & 0 deletions version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v0.4.3

0 comments on commit 48095e1

Please sign in to comment.