Skip to content

Commit 475fce6

Browse files
committed
README
1 parent 7313a84 commit 475fce6

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,57 @@
11
# MeowScript
22
MSC is an EsoLang
3+
4+
## Overview
5+
The MSC Interpreter is a simple command-line tool written in C that interprets a programming language known as MSC. MSC is a language with a syntax inspired by the sounds made by cats: "meow," "hiss," and "purr."
6+
7+
## Usage
8+
To use the MSC Interpreter, follow these steps:
9+
10+
1. **Download the Interpreter:**
11+
You can download the MSC Interpreter for Windows [here](https://github.com/RAH-Code-dev/MeowScript/releases/latest)
12+
13+
2. **Run a MSC Program:**
14+
```bash
15+
meowscript <filename.meow>
16+
```
17+
18+
Replace `<filename.meow>` with the path to your MSC program file.
19+
20+
## MSC Syntax
21+
MSC consists of three commands:
22+
23+
- **meow:** Increments the ASCII value.
24+
- **hiss:** Decrements the ASCII value.
25+
- **purr:** Outputs the ASCII character.
26+
27+
### Example MSC Program
28+
```meowscript
29+
meow meow meow meow meow meow meow meow
30+
meow meow meow meow meow meow meow meow
31+
meow meow meow meow meow meow meow meow
32+
meow meow meow meow meow meow meow meow
33+
meow meow meow meow meow meow meow meow
34+
meow meow meow meow meow meow meow meow
35+
meow meow meow meow meow meow meow meow
36+
meow meow meow meow meow meow meow meow
37+
meow hiss meow purr
38+
```
39+
This program increments the ASCII value 65 times, decrements it once, increments it once, and then outputs the corresponding ASCII character `A`.
40+
41+
## Building from Source
42+
If you want to build the MSC Interpreter from source, make sure you have a C compiler installed. Use the following commands:
43+
44+
```bash
45+
make install
46+
```
47+
48+
## Contributing
49+
Contributions are welcome! If you find any issues or have improvements to suggest, please open an issue or create a pull request on the [GitHub repository](https://github.com/RAH-Code-dev/MeowScript).
50+
51+
## License
52+
This project is licensed under the MIT License - see the [LICENSE](https://github.com/RAH-Code-dev/MeowScript/blob/main/LICENSE) file for details.
53+
54+
## Acknowledgments
55+
The MSC Interpreter was created by Milo Snow Cat. Special thanks to the feline community for the inspiration!
56+
57+
Feel free to meow, hiss, or purr your way through the world of MSC!

0 commit comments

Comments
 (0)