Skip to content

Commit

Permalink
Updated README with docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bauripalash committed Jul 10, 2020
1 parent f5c03e4 commit 3bbfdb1
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,38 @@
# /ᐠ。ꞈ。ᐟ\ MewMew Programming Language
### Program in Cats' Language

MewMew is an Esoteric `Just for Fun` programming language. You can use MewMew to program in cats' language.

## Get Started
#### Integers
There's no concept of numbers (eg. 1 2 3 4 100) in MewMew, instead we use `mew`s. 1 `mew` is equal to 1 , therefor `mewmew` = 2 , `mewmewmew` = 3 , `mewmewmewmewmewmewmewmewmewmew` = 10. (You got the Idea right)

#### Operators
MewMew supports a few types of operators =>
* `+` -> Addition
* `-` -> Subtraction
* `*` -> Multiplication
* `/` -> Division
* `**` -> Power
* `~` -> Absolute Value
* `-` -> Unary Minus
* `>` -> Greater than
* `>=` -> Greater than equal to
* `<` -> Less than
* `<=` -> Less than equal to
* `==` -> Is Equal to
* `!=` -> Not Equal to
* `&` -> And
* `|` -> Or
* `%` -> Modulus (Remainder)

#### Identifiers
MewMew identifiers must start with an `m` and can contain zero or more consecutive `_` and `w`. `e` cannot be used , because the interpreter can confuse it with a mew number.

#### Assignment
`ID = Expression`
IDs will follow the rules of identifiers (above mentioned)

#### Print aka. *Meow Say*
There's no keyword , to print we use the `::` symbol, for example
`::mewmew + mewmew` outputs `4`
Expand All @@ -20,6 +48,21 @@ If statement of mewmew is very similar to ternary expression of C/C++.
`@TIMES : BODY ;`
Where `TIMES` can be any mew number , and the `BODY` will be executed `TIMES` times.

#### Scratch Functions
`#MEWNUMBER` (The '#' can be 1 to 5 consecutive times )
* 1 `#` calculates square root of the expression
* 2 `#` returns 2 times the given expression
* 3 `#` returns 5 times the given expression
* 4 `#` returns 10 times the given expression
* 5 `#` returns 100 times the given expression

#### Comments
'//'
To write a comment , start the sentence with `//`

## NOTEs:
* MewMew is an esoteric language , it was never intended to be used for mainstream programming.
* MewMew is only tested on Linux device (Ubuntu 18.04 x86_64). Building on Windows or MacOS should not be difficult , Please let me know , if you build it on either Windows or MacOs.

## Building Yourself
#### Required
Expand Down

0 comments on commit 3bbfdb1

Please sign in to comment.