add readme

This commit is contained in:
2026-04-05 18:49:01 +10:00
commit 51a6ada1e7

28
README.md Normal file
View File

@@ -0,0 +1,28 @@
# Welcome to Ground!
This org contains most Ground-related stuff that you'll want to find.
## What is Ground?
Ground is a bytecode VM (however some people also insist on it being a programming language). It's fast, light, and extensible.
## Maintainers
[Max](https://chookspace.com/max): Core interpreter
[DiamondNether90](https://chookspace.com/DiamondNether90): Libraries, tooling, documentation, bug fixes, pestering Max to fix bugs
[SpookyDervish](https://chookspace.com/SpookyDervish): Libraries and Dig package manager.
## Important repositories
[Core Interpreter](https://chookspace.com/ground/ground): Core GroundVM which actually runs code. Also contains essential libraries such as fileio and request
[Dig package manager](https://chookspace.com/ground/digpkg): Package manager to easily install Ground libraries. View packages [here](https://chookspace.com/ground/-/packages). Maintained by [SpookyDervish](https://chookspace.com/SpookyDervish).
[Syntax highlighter](https://chookspace.com/ground/discord-syntax-highlighter): Highlights syntax for sending in Discord chats, helpful for sharing debug info. Maintained by [DiamondNether90](https://chookspace.com/DiamondNether90)
## Historical repositories
These repos used to be active, however are usually not used anymore. They are kept around for archival purposes.
[Old interpreter](https://chookspace.com/ground/ground-old): Old C++ based Ground interpreter. Max used to be very bad at C++ so this was a very unmaintainable version
[Gride](https://chookspace.com/ground/gride): Buggy mess of a Ground IDE. Worked in a web browser, with a Flask app providing a bridge to the Ground process.
[GroundPy](https://chookspace.com/ground/GroundPY): [SpookyDervish](https://chookspace.com/SpookyDervish)'s original attempt at compiling Ground to ASM. It does work for some things!
[Old libraries](https://chookspace.com/ground/libraries): Old external libraries for the old interpreter. The new interpreter has a different API so these are incompatible.