Skip to content

Commit 4729eda

Browse files
authored
Merge pull request #3 from was07/patch-1
Clean up README.md
2 parents 16d0f19 + 89bbc4e commit 4729eda

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,9 @@
66

77
[NumberScript Discord-Invite](https://discord.gg/wRXR72zJ6W)
88

9-
possibly the world's most simplest and restricted language.
9+
Possibly the world's most simple and restricted language.
1010

11-
## Installation
12-
13-
### pip
11+
## Installation (pip)
1412

1513
```bash
1614
pip install NumberScript
@@ -27,15 +25,13 @@ pip install NumberScript
2725

2826
## CLI and repl
2927

30-
To use the repl just run,
31-
28+
To use the repl just run
3229
`python -m NumberScript`
3330

34-
To run a file just use this,
35-
31+
To run a file use
3632
`python -m NumberScript -f Path/To/File`
3733

38-
### commands
34+
### Commands
3935

4036
```
4137
commands: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7
@@ -48,10 +44,10 @@ If-Else: ? :
4844
```
4945

5046
>NOTE: You can't have different arithmetic signs in a single ^
51-
> : so you can do this 1+1+2 but not 1+1*2
47+
> : meaning you can do 1+1+2 but not 1+1*2
5248
> : Also NO SPACES.
5349
54-
### syntax
50+
### Syntax
5551

5652
A basic program
5753
```
@@ -62,10 +58,10 @@ A basic program
6258
?a=Hello:2a:2Bye %Check-A-If-Its-Hello-Then-Display-It-Else-Display-Bye
6359
1 %Ends %The %program
6460
```
65-
You can also have that program like this
61+
Removing the comments, You can also have this program like
6662
`0 3a:Hello 2a 4a=Hello:2a:2Bye 1`
6763

68-
Here is another program where it loops over digits to check if it's lucky
64+
Here is another program that loops over digits to check if they are lucky
6965
```
7066
%Is-This-lucky:Checks-If-The-Number-Is-Lucky
7167
0
@@ -74,12 +70,12 @@ Here is another program where it loops over digits to check if it's lucky
7470
1
7571
```
7672

77-
You can find more examples in the examples folder.
73+
You can find more examples in the `examples` folder.
7874

7975
>So, since there aren't any spaces what can we use instead of them?
8076
>You can use _ or -.
8177
8278
## To-Do
8379

8480
- [ ] Import and library system
85-
- [ ] Possibly OOP
81+
- [ ] Possibly OOP

0 commit comments

Comments
 (0)