https://github.com/mufeedvh/regretti
A programming language where comments are the first-class citizen and ASCII art flowcharts are the controls!
https://github.com/mufeedvh/regretti
Last synced: about 1 year ago
JSON representation
A programming language where comments are the first-class citizen and ASCII art flowcharts are the controls!
- Host: GitHub
- URL: https://github.com/mufeedvh/regretti
- Owner: mufeedvh
- License: mit
- Created: 2021-08-21T05:16:01.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-07-01T16:52:47.000Z (about 3 years ago)
- Last Synced: 2025-04-30T15:23:16.126Z (about 1 year ago)
- Language: Rust
- Size: 73.2 KB
- Stars: 27
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
regretti 🤌🍝
A programming language where comments are the first-class citizen and ASCII art flowcharts are the controls!
---
> Made for [Lang Jam (`jam0001`)](https://github.com/langjam/jam0001) theme: **first-class comments** in 48 hours.
> **UPDATE:** regretti [won](https://www.youtube.com/watch?v=j7VAw8UfMeA&t=466s) Lang Jam (`jam0001`)!
## Summary
What if all those "`TODO:`" comments and beautiful ASCII art diagrams in your code actually worked? Presenting you the one and only _regretti_, write your _spaghetti_ and _forgetti_!
> _Basically, I took the theme "literally"!_
So comments are **commands**!
You can only run instruction statements inside a comment! 💬
## Table of Contents
* [Features](#goals)
* [Installation](#installation)
* [Quick Start](#hello-world)
* [Examples](#examples)
* [Language Internals](#internals)
## Goals
- **Teaching:** What initially started as a troll/esoteric language, this language could be used to teach kids "Control Flows" visually.
- **Fast:** The existing functionality/examples runs faster than most interpreted languages!
- **Helpful Error Messages:** Almost every errors will be catched and prints out a helpful error message as to denote what went wrong. (Inspired from Rust :heart:)
## Installation
**NOTE:** Please run on **Linux**.
```
$ git clone https://github.com/mufeedvh/regretti.git
$ cd regretti/
$ cargo build --release
$ ./target/release/regretti
```
## Hello World
Lo and behold!
```
main:
/*
+----------------------+
| print "Hello World!" |
+----------------------+
*/
```
**Loops**
```
main:
let count = 69420
/*
+--------+
| loop 5 |<----------+
+--------+ |
| v
| +-------------+
| | print count |
| +-------------+
| ^
| |
+---------------+
*/
:end
```
Get more examples below!
## Examples
Examples are the best way to learn regretti, these cover all the features and functionalities of the language:
- [Hello World](https://github.com/mufeedvh/regretti/blob/main/examples/helloworld.reg)
- [If Else](https://github.com/mufeedvh/regretti/blob/main/examples/if_else.reg)
- [Loops](https://github.com/mufeedvh/regretti/blob/main/examples/loop.reg)
_All other examples have not been completely implemented yet._
_Also I am pretty sure there are a lot of bugs, this is probably the most obscure syntax for parsing lol..._
### Flow Charts?
## Internals
**In a nutshell:**
_https://xkcd.com/1209/_
---