ground_old_fork/README.md

# Ground - A speedy platform for building cool software

## What is Ground?

Ground is a sigma interpreter which processes and interprets Ground instructions. It is quite fast, and the syntax is simple.

## What are the main features of Ground?

* **Simple syntax:** Ground doesn't have very many features, and that's intentional. It makes Ground easy to learn, and keeps it speedy.
* **Super speed:** Ground code is faster than Python and JavaScript, and nearly as fast as C++ and Rust, while still being interpreted. (Tested using tests/to1000.grnd)
* **Tiny interpreter:** Ground contains 1482 lines of code (and 382 lines of comments) at the time of writing, and compiles in seconds.
* **Portable:** Ground's code only uses features from the C++ standard library, using features from C++17 and prior.

## How do I get started?

Clone the repo and compile with your favourite C++ compiler:

```
  g++ src/main.cpp -std=c++17 -O3 -o ground
```

(You can omit the -std flag on systems which default to the latest standard, and the -O3 flag if you're fine with a slightly slower interpreter.)

Run a Ground program:

```
  ./ground tests/input.grnd
```

If you'd like to create your own Ground programs, read the files in the docs/ folder of the repository.

## Contributing

If you want to help out, feel free to clone the repo and send pull requests! All the code is documented.

Feature requests also welcome! Reach out by emailing max at chookspace dot com.