Skip to content

Commit

Permalink
document language features (#55)
Browse files Browse the repository at this point in the history
  • Loading branch information
wcho21 authored Jan 31, 2024
1 parent b49c6b6 commit 88eb74e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 17 deletions.
20 changes: 11 additions & 9 deletions README.md
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
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

0 comments on commit 88eb74e

Please sign in to comment.