# Sym - 1.0.0

Sym (Symbolic) is stackbase programming language. It has smallest struct and tiny instructions base
d symbolic.

[[English](https://github.com/Q0tzly/sym/blob/main/README.md)|[日本語](https://github.com/Q0tzly/sym/blob/main/docs/README.ja.md)]

## Features

- Simple syntax
- Minimal operator based symbolic
- Only u8 type supported
- Reverse Polish Notation

## How to install

To install the sym you need to run the following command. This assumes that cargo is installed.

``` sh
cargo install sym-lang
```

## How to execution

The file extension is `.sym`.

``` sh
sym run <path_to_file.sym>
```

## Documents

If you want to know the syntax of one, should check [documents](https://q0tzly.github.io/sym/en/book/index.html).

## Samples

The detail examples are the [examples](https://github.com/Q0tzly/sym/tree/main/examples) directory.

## Contribution

When you find bug, issue the issue. When you hope contribution, send pull request.

## License

Sym Lang is the [MIT License](https://github.com/Q0tzly/sym/blob/main/LICENSE).