hindiscript-lang/README.md

HindiScript – A tiny Hindi-first toy language that runs .hs files. Created by Atikin Verse.

# 🪔 HindiScript

A fun, beginner-friendly, **Hindi language-based programming language** built for Indian developers who want to code in their own mother tongue.
With syntax inspired by **Hindi words and grammar**, HindiScript makes programming more relatable, fun, and culturally connected.

**Created by Atikin Verse.**

---


## 📌 Snippets

This is a simple code snippet table for HindiScript projects.

| 🧠 **HindiScript Syntax**   | 💻 **JavaScript Equivalent**               |
| --------------------------- | ------------------------------------------ |
| `ले x = 5`                  | `let x = 5`                                |
| `स्थिर y = 10`              | `const y = 10`                             |
| `छाप "नमस्ते"`              | `console.log("नमस्ते")`                    |
| `अगर (x > 3)`               | `if (x > 3) {`                             |
| `वरना`                      | `} else {`                                 |
| `जबतक (x < 5)`              | `while (x < 5) {`                          |
| `कार्य नमस्ते(नाम)`         | `function namaste(name) {`                 |
| `लौटाओ x * y`               | `return x * y`                             |
| `कार्य समाप्त`              | `}`                                        |
| `बुलाओ नमस्ते("मित्र")`     | `namaste("मित्र")`                         |
| `सत्य`                      | `true`                                     |
| `झूठ`                       | `false`                                    |
| `पढ़ो_फाइल "data.txt"`      | `fs.readFileSync("data.txt", "utf-8")`     |
| `लिखो_फाइल "out.txt", "hi"` | `fs.writeFileSync("out.txt", "hi")`        |
| `कोशिश करो`                 | `try {`                                    |
| `पकड़ो (त्रुटि)`            | `} catch (error) {`                        |
| `त्रुटि "संदेश"`            | `throw new Error("संदेश")`                 |
| `घटना click = छाप "ok"`     | `click = function() { console.log("ok") }` |

---


## 🚀 Features

* **Pure Hindi syntax** for variables, loops, and conditions.
* Easy-to-use **CLI tool** for running `.hs` files.
* Works without showing or mentioning JavaScript.
* Beginner-friendly — learn programming in your own mother tongue.
* File operations (read/write), error handling, and event handling in Hindi.
* Created with ❤️ by **Atikin Verse**.

---


## 🔧 Installation

| Step                       | Command / Description                                      |
| -------------------------- | ---------------------------------------------------------- |
| Clone the repository       | `git clone https://github.com/atikinverse/hindiscript.git` |
| Navigate to project folder | `cd hindiscript`                                           |
| Install globally           | `npm install -g .`                                         |
| Run a HindiScript file     | `hindiscript path/to/file.hs`                              |

---


## 🏁 Getting Started

**1. Create a `.hs` file**
Example: `hello.hs`

```hindi
# 1️⃣ Hello World

कार्य मुख्य() {
    छापो("नमस्ते दुनिया!");
}

परीक्षण1();

# Output: नमस्ते, दुनिया!
```

---


```hindi
## 2️⃣ Variable Declaration

कार्य मुख्य() {
    केवल नाम = "आटिकिन वर्स";
    छापो("मेरा नाम है: " + नाम);
}

परीक्षण2();

# Output: मेरा नाम है: आटिकिन वर्स
```

---

```hindi
# 3️⃣ If-Else

कार्य मुख्य() {
    केवल अंक = 75;
    यदि (अंक > 50) {
        छापो("आप पास हो गए!");
    } अन्यथा {
        छापो("आप फेल हो गए!");
    }
}

परीक्षण3();

# Output: आप पास हो गए!
```

---


```hindi
# 4️⃣ While Loop

कार्य मुख्य() {
    केवल i = 1;
    जबतक (i <= 5) {
        छापो("संख्या: " + i);
        i = i + 1;
    }
}

परीक्षण4();

# Output: 

संख्या: 1
संख्या: 2
संख्या: 3
संख्या: 4
संख्या: 5

```

---

```hindi
# 5️⃣ Array

कार्य मुख्य() {
    केवल फल = ["आम", "केला", "सेब"];
    छापो("पहला फल: " + फल[0]);
    छापो("कुल फल: " + फल.लंबाई);
}

परीक्षण5();

# Output: 

पहला फल: आम
कुल फल: 3

```

---

```hindi
# 6️⃣ For Loop

कार्य मुख्य() {
    पुनः (केवल i = 0; i < 3; i = i + 1) {
        छापो("गिनती: " + i);
    }
}

परीक्षण6();

# Output: 

गिनती: 0
गिनती: 1
गिनती: 2

```

---

```hindi
# 7️⃣ Function with Return

कार्य जोड़ो(a, b) {
    वापसी a + b;
}

कार्य मुख्य() {
    केवल परिणाम = जोड़ो(10, 20);
    छापो("परिणाम: " + परिणाम);
}

परीक्षण7();

# Output: परिणाम: 30


```

---

```hindi
# 8️⃣ Object Usage

कार्य मुख्य() {
    केवल छात्र = { नाम: "सुरेश", उम्र: 20 };
    छापो("छात्र का नाम: " + छात्र.नाम);
}

परीक्षण8();

# Output: छात्र का नाम: सुरेश
```

---

```hindi
# 9️⃣ Array Methods

कार्य मुख्य() {
    केवल संख्याएँ = [1, 2, 3, 4];
    संख्याएँ.जोड़ो(5);
    छापो("नया ऐरे: " + संख्याएँ);
}

परीक्षण9();

# Output: नया ऐरे: 1,2,3,4,5
```

---

```hindi
# 🔟 Async + Timeout

अप्रत्याशित कार्य मुख्य() {
    छापो("1 सेकंड बाद संदेश आएगा...");
    समयबाद(() => {
        छापो("नमस्ते, मैं देर से आया!");
    }, 1000);
}

परीक्षण10();

# Output:

1 सेकंड बाद संदेश आएगा...
नमस्ते, मैं देर से आया!
```

---


## ⚙️ Installation (Quick)

```bash
npm install -g hindiscript
```

---


## 🧪 Usage

CLI द्वारा HindiScript फाइल चलाएँ:

```bash
hindiscript path/to/file.hs
```

**Example:**

```bash
hindiscript samples/hello.hs
```

---


## 🔖 License

Provided under the MIT License.

---


## 🧑‍💻 Creator

Atikin Verse
Made with ❤️ for learning and love for languages.

---


## FOLLOW US ON For more information:

Join our social media for exciting updates, news, and insights! Follow us on :

<!--Table-->
| ACCOUNTS                 | USERNAME          |
|------------              | --------------    |
| FACEBOOK                 | atikinverse       |
| INSTAGRAM                | atikinverse       |
| LINKEDIN                 | atikinverse       |
| TWITTER (X)              | atikinverse       |
| THREADS                  | atikinverse       |
| PINTREST                 | atikinverse       |
| QUORA                    | atikinverse       |
| REDDIT                   | atikinverse       |
| TUMBLR                   | atikinverse       |
| SNAPCHAT                 | atikinverse       |
| SKYPE                    | atikinverse       |
| GITHUB                   | atikinverse       |

---


**HindiScript — हिन्दी में मज़ेदार कोडिंग! 🚀**