revo

# `revo, the programming language

[homepage & docs](https://revo.lung.fyi)
| [introduction & learn](https://revo.lung.fyi/docs)
| [playground](https://revo.lung.fyi/ide)
| [source & issues](https://github.com/if-not-nil/revo)
| [discuss & chat](https://discord.com/invite/XzGWh7TX59)

an expressive, dynamically-typed language for the joy of programming

> browser-runnable examples [here](https://revo.lung.fyi/docs)
<img width="498" height="550" alt="demo" src="https://github.com/user-attachments/assets/b2579a32-6ce2-4894-9afb-8ece32acb321" />

![written in Zig](https://img.shields.io/badge/written%20in-Zig-orange) ![version 0.1.2](https://img.shields.io/badge/version-0.1.2-navy)

[tools](#tools)
| [editors](#editors)
| [credits](#credits)
| [examples](./examples)
| [made with revo](#made-with-revo)

## get

the latest release is hosted at [github releases](https://github.com/if-not-nil/revo/releases)

however, this project is rapidly changing. i recommend you build from source instead

## install from source

you need [zig](https://ziglang.org/download) `0.17.0` to build revo

i also recommend the [anyzig](https://github.com/marler8997/anyzig) version manager

### linux/bsd/mac/etc

```bash
git clone https://github.com/if-not-nil/revo --recursive && cd revo
git submodule update --init --recursive
zig build --fetch
zig build -Doptimize=safe
                  # =small for a ~1mb executable
                  # =fast  for a ~5%-10% performance gain (harder to report bugs on)
cp ./zig-out/bin/revo ~/.local/bin/revo

revo
```

#### nix

this project has a flake which exposes revo as a package on `default`\
you can open a shell with revo using `nix shell github:if-not-nil/revo?dir=extra/nix`\
there is also a function that bundles a revo script into a nix package

#### windows

> [!NOTE]
> some features are unavailable on windows. i recommend using WSL with the linux steps

```bash
git clone https://github.com/if-not-nil/revo && cd revo
zig build --fetch -Doptimize=fast

mkdir "C:/tools/revo/bin"
copy ./zig-out/bin/revo C:/tools/revo/bin

# now add it to PATH by doing:
# - Win+S -> `env` -> <Enter> -> "Environment Variables" -> "Path" -> "System Variables"
# - add new at "C:\tools\revo\bin" -> click ok -> reopen your terminal

revo
```

### tools

- `lsp`

  diagnostics, highlighting, etc. in your editor!\
  bundled by default with your revo\
  [how to use in your text editor](./src/lsp/README.md)

- `tree-sitter`

  gives most editors revo syntax highlighting support
  [doomy/tree-sitter-revo on codeberg](https://codeberg.org/doomy/tree-sitter-revo)

- `docs`

  output docs in plaintext/html

  ```text
  revo doc <file or directory>
  revo doc --html <file or directory>
  ```

- `fmt`

  format `.rv` files

  ```text
  revo fmt                          format every .rv under the pwd
  revo fmt script.rv dir/           format that in place
  revo fmt --check .                list files whose formatting differs
  revo fmt --diff .                 print a