Skip to content

Commit 50f5e77

Browse files
authored
Create README.md
1 parent 2df49df commit 50f5e77

1 file changed

Lines changed: 128 additions & 0 deletions

File tree

README.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
2+
# 🐾 냥스크립트 (`NyanScript`)
3+
4+
> **"집사가 코드를 짜면, 고양이가 실행한다냥!"** > **The world's cutest esoteric programming language.**
5+
6+
냥스크립트(NyanScript)는 고양이의 습성을 모티브로 한 한국어 기반의 난해한 프로그래밍 언어(Esoteric Language)입니다.
7+
8+
Python을 기반으로 동작하며, 딱딱한 영어 문법 대신 귀여운 고양이 용어로 코딩할 수 있습니다.
9+
10+
<br />
11+
12+
## ✨ 특징 (Features)
13+
14+
* **고양이 친화적 문법:** `while` 대신 `꾹꾹이`, `print` 대신 `야옹`을 사용합니다.
15+
* **파이썬 호환:** `.nyan` 파일을 파이썬 코드로 변환(Transpile)하여 실행하므로, 파이썬의 모든 라이브러리(`import random`, `time` 등)를 사용할 수 있습니다.
16+
* **쉬운 난이도:** 구조는 파이썬과 유사하여 초보 집사도 쉽게 배울 수 있습니다.
17+
18+
<br />
19+
20+
## 📦 설치 및 실행 방법 (Installation & Usage)
21+
22+
### 1. 필수 조건
23+
24+
* Python 3.x 가 설치되어 있어야 합니다.
25+
26+
<br />
27+
28+
### 2. 실행 방법
29+
30+
프로젝트 폴더에 `nyan.py` (인터프리터)와 `.nyan` (소스 코드) 파일이 있어야 합니다.
31+
32+
```bash
33+
# 기본 실행 명령어
34+
python nyan.py [파일이름.nyan]
35+
36+
```
37+
38+
**예시:**
39+
40+
```bash
41+
python nyan.py hello.nyan
42+
43+
```
44+
45+
<br />
46+
47+
---
48+
49+
## 📚 문법 가이드 (Syntax Guide)
50+
51+
냥스크립트는 **들여쓰기(Indentation)**가 매우 중요합니다. 블록(`{ }`)을 사용할 때 들여쓰기 줄을 잘 맞춰주세요.
52+
53+
| 기능 | 냥스크립트 (Keyword) | 파이썬 (Python) | 설명 |
54+
| --- | --- | --- | --- |
55+
| **시작** | `기지개 { ... }` | `if __name__ == "__main__":` | 프로그램의 시작점입니다. |
56+
| **종료** | `식빵굽기` | `pass` | 프로그램의 끝을 알립니다. |
57+
| **변수** | `박스 [이름] = [값]` | `[이름] = [값]` | 변수를 선언합니다. |
58+
| **출력** | `야옹(...)` | `print(...)` | 화면에 내용을 출력합니다. |
59+
| **입력** | `쫑긋(...)` | `input(...)` | 사용자의 입력을 받습니다. |
60+
| **반복** | `꾹꾹이 (조건) { ... }` | `while (조건):` | 조건이 참일 동안 반복합니다. |
61+
| **조건** | `간식주면 (조건) { ... }` | `if (조건):` | 조건이 참이면 실행합니다. |
62+
| **그 외** | `아니면 { ... }` | `else:` | 조건이 거짓이면 실행합니다. |
63+
| **참/거짓** | `잡았다` / `놓쳤다` | `True` / `False` | 불리언(Boolean) 값입니다. |
64+
| **에러** | `하악질(...)` | `raise Exception(...)` | 강제로 에러를 발생시킵니다. |
65+
| **대기** | `낮잠(초)` | `time.sleep(초)` | 지정한 시간만큼 멈춥니다. |
66+
| **주석** | `그루밍: ...` | `# ...` | 실행되지 않는 설명글입니다. |
67+
68+
<br />
69+
70+
---
71+
72+
## 🐈 코드 예제 (Examples)
73+
74+
### 1. Hello World (안녕 세상아)
75+
76+
```javascript
77+
기지개 {
78+
야옹("안녕? 나는 코딩하는 고양이다냥!")
79+
} 식빵굽기
80+
81+
```
82+
83+
<br />
84+
85+
### 2. 츄르 먹기 (반복문)
86+
87+
```javascript
88+
기지개 {
89+
박스 츄르 = 3
90+
91+
꾹꾹이 (츄르 > 0) {
92+
야옹("냠냠... 남은 츄르: ", 츄르)
93+
츄르 = 츄르 - 1
94+
}
95+
96+
야옹("꺼억! 잘 먹었다냥.")
97+
} 식빵굽기
98+
99+
```
100+
101+
---
102+
103+
<br />
104+
105+
## 🛠️ 개발 환경 구조 (File Structure)
106+
107+
```text
108+
📂 Project_Nyan
109+
├── 📜 README.md # 프로젝트 설명서
110+
├── 🐍 nyan.py # 냥스크립트 인터프리터 (Core)
111+
├── 🐱 hello.nyan # 예제 코드
112+
└── 🐱 fibo.nyan # 예제 코드
113+
114+
```
115+
116+
<br />
117+
118+
## ⚖️ 라이선스 (License)
119+
120+
이 프로젝트는 **Mozilla Public License Version 2.0 (MPL 2.0)** 을 따릅니다.
121+
122+
> This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at [https://mozilla.org/MPL/2.0/](https://mozilla.org/MPL/2.0/).
123+
124+
소스 코드를 수정하여 배포할 경우, 해당 파일의 소스 코드를 공개해야 합니다. 단, 실행 파일 형태의 배포나 다른 라이선스를 가진 코드와 결합하여 사용하는 것은 더 자유롭습니다.
125+
126+
---
127+
128+
Made with 🐟 and 🧶 by j2doll

0 commit comments

Comments
 (0)