maid-lang 1.1.0

Maid Programming Language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

<div align="center">
  <picture>
    <img
         src="resources/icons/maid.png"
         width="16%">
  </picture>

[Website](https://maidcode.me/) | [Download](https://crates.io/crates/maid-lang) | [Guidebook](https://maidcode.me/docs/getting-started/installation) | [Documentation](https://maidcode.me/docs/server-actions/getToken) | [Online Interpreter](https://maid-web-backend.fly.dev/)

_A very simple interpreted programming language for beginners._
</div>

## Code in Action

```
# import the math module
fetch std_math;

obj x = 0;

# let's go for a walk!
walk i = 0 through 10 {
    obj x = x + 1;

    if x == 5 {
        leave;
    }
}

# print the value of 'x'
serve(x);

# greet someone
func greet(name) {
    serve("Hello, " + name + "!");
}

greet("my Maid");

serve("Pi is equal to: " + tostring(math_pi));
serve("We have reached the end of our program. I hope you enjoyed!");
```

```
# import the math module
fetch std_math; # imports
serve(math_pi); # built in functions
obj x = 0; # object creation

# looping
walk i = 0 through 10 {
    serve("'i' is equal to: " + tostring(i));

    if i == 5 {
        leave;
    }
}

while 1 == 1 {
    serve("Inside a while loop");

    leave;
}

# function definitions
func greet(name) {
    serve("Hello my " + name + "!");

    give null;
}

greet("Maid");

```

## Features

- Built-in modules for math, strings, and more
- Easy-to-understand functions like `sweep()`, `stash()`, and `uhoh()`
- Package management extensible with `fetch`
- Open source & updated regularly. 
- [Online Interpreter](https://maid-web-backend.fly.dev/) is live! Play with Maid in your browser!

## Easily add it as a VS Code Extension!

### 1) From the Marketplace 
- Open VS Code → **Extensions** (Ctrl/Cmd + Shift + X) - Or click the extensions button on the left side-bar upon opening VS Code.
- Search for **“Maid”** or go directly:  
  **https://marketplace.visualstudio.com/items?itemName=xqyet.maid-lang**
- Click **Install**
<p align="left">
  <img src="resources/icons/maid-vscode.png" alt="Searching for Maid in VS Code" width="35%">
</p>
- after installing the extension, run: 


```bash
cargo install maid-lang

```
or follow the popup box prompt to install cargo, and then to install maid.

## Package Installation (for other text editors and IDE's)

You can install **Maid** Programming Language globally using [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) which comes pre-packaged when downloading Rust:

```bash
cargo install maid-lang

```
Once installed, run the maid command:
```
maid new project
cd project
maid home.maid
```
Watch your output:

```
'Hello, my Maid!'
```

Now get busy creating in Maid! You may also check out the quick setup instructions in the [Guide Book](https://maidcode.me/docs/getting-started/installation) which I may extend upon.

## Wanna Help Out?

Contributors are welcome! Also feel free to try my [Online Interpreter](https://maid-web-backend.fly.dev/) for Maid.

I’m currently working on making Maid installable through some other popular package managers, so in the future you’ll be able to run npm install maid, yarn add maid, or pip install maid in addition to my current cargo package.

![Interpreter](https://github.com/xqyet/MaidCode/raw/main/resources/icons/interpreter.png)


## License

Maid is **free & open source.**