mirror of
https://github.com/Stone-Red-Code/YesNt-Interpreter.git
synced 2026-09-09 07:56:06 +02:00
Add proper docs
This commit is contained in:
@@ -1,12 +1,17 @@
|
||||
# YesNt
|
||||
|
||||
|
||||
> YesNt is a imperative and interpreted language inspired by the Assembly language.
|
||||
|
||||
## Syntax
|
||||
## Documentation
|
||||
|
||||
Current language syntax is documented in [SYNTAX_V2.md](SYNTAX_V2.md).
|
||||
| Document | Description |
|
||||
| -------------------------------------------------------- | ----------------------------------------- |
|
||||
| [docs/README.md](docs/README.md) | Getting started |
|
||||
| [docs/language-reference.md](docs/language-reference.md) | Full language reference |
|
||||
| [docs/library-api.md](docs/library-api.md) | Embedding the interpreter as a C# library |
|
||||
| [docs/editor.md](docs/editor.md) | Using the terminal code editor |
|
||||
|
||||
Example:
|
||||
## Quick example
|
||||
|
||||
```ynt
|
||||
var name = world
|
||||
@@ -16,6 +21,5 @@ print_line Hello ${name}
|
||||
## Run
|
||||
|
||||
```bash
|
||||
dotnet run --project YesNt.Interpreter -- path/to/script.ynt
|
||||
dotnet run --project YesNt.Interpreter.App -- path/to/script.ynt
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user