Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add readme in korean #41

Merged
merged 9 commits into from
Dec 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
[![English](https://img.shields.io/badge/Lang-en-green)][readme-en]
[![Korean](https://img.shields.io/badge/Lang-ko-blue)][readme-ko]

[readme-en]: ./
[readme-ko]: ./docs/README_KR.md



# 🗡️ KAL

<img src="./docs/images/kal-logo.png" alt="KAL logo" width="128px" height="128px" />
Expand All @@ -16,6 +24,8 @@ Try _KAL_ at [KAL Playground][playground].

## 🗡️ Examples

### Statements and expressions

Variable assignment:
```
사과 = 42
Expand All @@ -35,6 +45,50 @@ Conditional statement:
}
```

Defining and calling function:
```
더하기 = 함수(숫자1, 숫자2) {
결과 숫자1 + 숫자2
}

더하기(42, 10)
```
which yields `52`.

Closure:
```
더하기 = 함수(숫자1) {
결과 함수(숫자2) {
결과 숫자1 + 숫자2
}
}

하나더하기 = 더하기(1)

하나더하기(42)
```
which yields `43`.



### Types

_Number type_: any floating-point numbers
```
사과 = 42
포도 = -9.5
```

_String type_: characters surrounded with single quotes
```
사과 = '맛있음'
```

_Boolean type_: `참`, `거짓`
```
사과 = 참
포도 = 거짓
```


## 🗡️ Manual building and installation
Expand Down
128 changes: 128 additions & 0 deletions docs/README_KR.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
[![English](https://img.shields.io/badge/Lang-en-green)][readme-en]
[![Korean](https://img.shields.io/badge/Lang-ko-blue)][readme-ko]

[readme-en]: ../
[readme-ko]: ./



# 🗡️ KAL

<img src="./images/kal-logo.png" alt="KAL logo" width="128px" height="128px" />

_KAL: Korean Algorithmic Language_.

한국어를 지원하는 인터프리터 언어.

_KAL_ 인터프리터를 브라우저에 로드하거나 직접 빌드하는 방법은 아래를 참고하세요.

_KAL_ 을 [플레이그라운드][playground]에서 체험해보세요.

[playground]: https://kal-playground.rooi.dev/



## 🗡️ 예시

### 문법들

변수 대입하기:
```
사과 = 42
```

값 비교하기:
```
사과 < 99
```

조건문 쓰기:
```
만약 사과 < 99 {
사과 = 99
} 아니면 {
사과 = 100
}
```

함수 사용하기:
```
더하기 = 함수(숫자1, 숫자2) {
결과 숫자1 + 숫자2
}

더하기(42, 10)
```
결과는 `52`입니다.

클로저:
```
더하기 = 함수(숫자1) {
결과 함수(숫자2) {
결과 숫자1 + 숫자2
}
}

하나더하기 = 더하기(1)

하나더하기(42)
```
결과는 `42`입니다.



### 타입들

_숫자 타입_: 아무 부동소수점 숫자
```
사과 = 42
포도 = -9.5
```

_문자열 타입_: 작은따옴표로 둘러싼 문자들
```
사과 = '맛있음'
```

_불리언 타입_: `참`, `거짓`
```
사과 = 참
포도 = 거짓
```


## 🗡️ 빌드와 설치

### 빌드하기

빌드 과정은 [Node.js][node]를 기반으로 합니다.

_KAL_ 인터프리터를 다음 커맨드로 [`pnpm`]을 이용해 빌드합니다.

```
pnpm install && pnpm build && pnpm bundle`
```


결과는 `/bundle/index.js` 디렉토리에 위치합니다.

[pnpm]: https://pnpm.io/
[node]: https://nodejs.org/



### 브라우저에서 사용하기

빌드한 파일 `index.js`를 원하는 디렉토리에 놓고, 다음과 같이 HTML 상에서 로드합니다.

```HTML
<script src="/your-directory/index.js"></script>
```

이후, _KAL_ 코드는 다음과 같이 `kal.execute(code-to-execute)`로 실행합니다.

```HTML
<script>
kal.execute("5+5"); // === 10
</script>
```