Skip to content

Commit 5f2d426

Browse files
Refactor README for clarity and organization
Updated formatting and added new sections in README.
1 parent 62cc18c commit 5f2d426

File tree

1 file changed

+36
-31
lines changed

1 file changed

+36
-31
lines changed

README.md

Lines changed: 36 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@
88

99
## 🌟 Features
1010

11-
- **Dynamic typing** with automatic type inference
12-
- **First-class lists** with literal syntax: `[1, 2, 3]`
13-
- **Control structures**: `if`, `loop`, `each` (for-each loop)
14-
- **Functions**: Built-in `print`, with user-defined functions (WIP)
15-
- **Expressions**: Arithmetic (`+`, `-`, `*`, `/`), comparisons (`==`, `!=`, `<`, etc.)
16-
- **Clean syntax**: No semicolons, indentation-like structure using `end`
17-
- **Memory management**: Reference counting for automatic cleanup
11+
- **Dynamic typing** with automatic type inference
12+
- **First-class lists** with literal syntax: `[1, 2, 3]`
13+
- **Control structures**: `if`, `loop`, `each` (for-each loop)
14+
- **Functions**: Built-in `print`, with user-defined functions (WIP)
15+
- **Expressions**: Arithmetic (`+`, `-`, `*`, `/`), comparisons (`==`, `!=`, `<`, etc.)
16+
- **Clean syntax**: No semicolons, indentation-like structure using `end`
17+
- **Memory management**: Reference counting for automatic cleanup
1818

1919
---
2020

2121
## 🚀 Example Program
2222

23-
```python
23+
```mas
2424
# Hello World
2525
print "Hello, MAS!"
2626
@@ -75,14 +75,20 @@ Count: 3
7575

7676
---
7777

78-
## 🛠️ Building & Running
78+
## ⬇️ Download & Releases
79+
80+
Pre-built binaries for Linux, macOS, and Windows are available on **[GitHub Releases](https://github.com/aditya-raj-arora/MASProgramming/releases)**.
81+
👉 **[Download the latest version](https://github.com/aditya-raj-arora/MASProgramming/releases/latest)**
82+
83+
---
84+
85+
## 🛠️ Building from Source
7986

8087
### Prerequisites
8188
- A C compiler (GCC or Clang)
82-
- Make
89+
- Make
8390

8491
### Build
85-
8692
```bash
8793
git clone https://github.com/aditya-raj-arora/MASProgramming.git
8894
cd MASProgramming/mas
@@ -93,7 +99,6 @@ make
9399
```bash
94100
./mas your_program.mas
95101
```
96-
97102
> Replace `your_program.mas` with the path to your MAS source file.
98103
99104
---
@@ -143,39 +148,37 @@ end
143148
```
144149

145150
### Data Types
146-
- **Number**: `42`, `3.14`
147-
- **String**: `"hello"` (supports `\n`, `\t`, `\"`)
148-
- **Boolean**: `true`, `false`
149-
- **Null**: `null`
151+
- **Number**: `42`, `3.14`
152+
- **String**: `"hello"` (supports `\n`, `\t`, `\"`)
153+
- **Boolean**: `true`, `false`
154+
- **Null**: `null`
150155
- **List**: `[1, "two", true]`
151156

152157
### Operators
153-
- Arithmetic: `+`, `-`, `*`, `/`
154-
- Comparison: `==`, `!=`, `<`, `<=`, `>`, `>=`
158+
- Arithmetic: `+`, `-`, `*`, `/`
159+
- Comparison: `==`, `!=`, `<`, `<=`, `>`, `>=`
155160
- Assignment: `=`
156161

157162
---
158163

159164
## 🧪 Testing
160165

161166
A sample test file is included:
162-
163167
```bash
164168
./mas test.mas
165169
```
166-
167170
This runs basic examples of variables, expressions, loops, and the `print` function.
168171

169172
---
170173

171174
## 📚 Learning Goals
172175

173176
This project demonstrates core concepts in programming language implementation:
174-
- Lexical analysis (tokenization)
175-
- Recursive descent parsing
176-
- Abstract Syntax Trees (AST)
177-
- Tree-walking interpreters
178-
- Runtime object model and memory management
177+
- Lexical analysis (tokenization)
178+
- Recursive descent parsing
179+
- Abstract Syntax Trees (AST)
180+
- Tree-walking interpreters
181+
- Runtime object model and memory management
179182

180183
It's ideal for students, hobbyists, or anyone wanting to build their first language!
181184

@@ -184,10 +187,10 @@ It's ideal for students, hobbyists, or anyone wanting to build their first langu
184187
## 🤝 Contributing
185188

186189
Contributions are welcome! Feel free to:
187-
- Fix bugs
188-
- Add new features (e.g., user-defined functions, more data types)
189-
- Improve error messages
190-
- Write more test cases
190+
- Fix bugs
191+
- Add new features (e.g., user-defined functions, more data types)
192+
- Improve error messages
193+
- Write more test cases
191194

192195
Just open a pull request with your changes.
193196

@@ -200,6 +203,8 @@ This project is open-source and available under the **MIT License**. See [LICENS
200203
---
201204

202205
> **Built with ❤️ for learners and creators.**
203-
> — Aditya Raj Arora
204-
> — Mukta Motwani
206+
> — Aditya Raj Arora
207+
> — Mukta Motwani
205208
> — Shivam Saini
209+
210+
---

0 commit comments

Comments
 (0)