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.

Sign up for GitHub

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

document language features #55

Merged
merged 1 commit into from
Jan 31, 2024
Merged

document language features #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 11 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,23 @@
[![Korean](https://img.shields.io/badge/Lang-ko-blue)][readme-ko]

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



# 🗡️ KAL
# 🗡️ KALANG

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

_KAL: Korean Algorithmic Language_.
_KALANG: Korean Programming Language_.

A simple interpreted language which supports Korean.
- < 0.03 MB.
- Written in JavaScript. Natively runs on web browsers.
- Minimal syntax with Korean keywords.

You can load a _KAL_ interpreter in browsers, or build manually (see below).
Try _KALANG_ at [Playground][playground].

Try _KAL_ at [KAL Playground][playground].
You can load a _KALANG_ interpreter in browsers, or build manually (see below).

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

Expand All @@ -30,7 +32,7 @@ Load the interpreter script in HTML as follows:
<script src="https://cdn.jsdelivr.net/gh/wcho21/kal@latest/dist/index.min.js"></script>
```

After that, you can execute _KAL_ code with `kal.execute(code-to-execute)` as follows:
After that, you can execute _KALANG_ code with `kal.execute(code-to-execute)` as follows:

```HTML
<script>
Expand Down Expand Up @@ -114,7 +116,7 @@ _Boolean type_: `참`, `거짓`

Note that building process is based on [Node.js][node].

With [`pnpm`][pnpm], you can build a _KAL_ interpreter by running `pnpm install && pnpm build && pnpm bundle`.
With [`pnpm`][pnpm], you can build a _KALANG_ interpreter by running `pnpm install && pnpm build && pnpm bundle`.

The output will be in the directory `/bundle/index.js`.

Expand Down
20 changes: 12 additions & 8 deletions docs/README_KR.md → docs/README.ko.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,21 @@



# 🗡️ KAL
# 🗡️ KALANG

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

_KAL: Korean Algorithmic Language_.
_KALANG: Korean Programming Language_.

한국어를 지원하는 인터프리터 언어.
한국어 프로그래밍 언어.

_KAL_ 인터프리터를 브라우저에 로드하거나 직접 빌드하는 방법은 아래를 참고하세요.
- < 0.03 MB.
- 자바스크립트로 작성되어 브라우저에서 바로 동작합니다.
- 한국어 키워드로 구성된 간단한 문법을 갖습니다.

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

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

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

Expand All @@ -30,7 +34,7 @@ _KAL_ 을 [플레이그라운드][playground]에서 체험해보세요.
<script src="https://cdn.jsdelivr.net/gh/wcho21/kal@latest/dist/index.min.js"></script>
```

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

```HTML
<script>
Expand Down Expand Up @@ -116,7 +120,7 @@ _불리언 타입_: `참`, `거짓`

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

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

```
pnpm install && pnpm build && pnpm bundle`
Expand Down
Loading