mare

A reimagining of the Pony language
HEAD Latest release released
jemc/mare
90 8 20
Joe Eli McIlvain

Mare

The ungui-angui-pede, a mascot for Mare

CircleCI Docker

Mare is a reimagining of the Pony language.

The goal is to create a language with all the desirable features of Pony, while simultaneously being more approachable to newcomers and more extensible for power users.

It's an early work in progress, but it can already compile and run basic programs.

Check out the feature roadmap and goals summary for more information on where this project is headed.

Try It!

There are a few ways you can try out Mare. All of them assume you have a working docker installation, so take a moment to take care of that first.

First, just to prove the basics, you can use the eval subcommand of the docker image to compile a program:

docker run --rm jemc/mare eval 'env.out.print("Hello, World!")'
# Prints "Hello, World!"

Beyond that, you can also use the docker image to compile a source code directory by mounting the directory into the container, like so:

# Compile the program.
docker run --rm -v ${PATH_TO_YOUR_CODE}:/opt/code jemc/mare
# Run the program.
${PATH_TO_YOUR_CODE}/main

If you're a VS Code user, you may be interested to install our language extension for that editor, which includes both syntax highlighting and some Intellisense features via using the docker image as an LSP server.

We also have a vim/nvim extension as well.

Finally, if you want to contribute to Mare, read on through the next section to learn about some of the basic development commands.

Contributing

Looking for ways to help? Here's a link that shows issue tickets filtered by those that should be ready to work on.

You can also filter by complexity label to try to find something that's the right level of challenge and time commitment for you.

If you're a new contributor looking for some guidance, please reach out to me (Joe Eli McIlvain) in a DM in this chat room to introduce yourself and even schedule pairing sessions where I can help you understand parts of the compiler or language that you're interested in learning more about.

Developing

To work on this project, you'll need docker and make. You may also want to have lldb for debugging.

To get started, clone the project to your development machine, then run one of the following commands within the project working directory:

  • Run make ready to prepare a docker container that has everything needed for development activities. Do this before running any of the other following commands:

  • Run make test to run the test suite.

  • Run make example-run dir="/opt/code/examples/adventofcode/2018 to compile and run from the sources in ./examples/adventofcode/2018 directory (or similarly for any other example code directory).

  • Run make example-lldb to do the same as above, but run inside lldb to allow you to breakpoint and step through code.

mare:
  github: jemc/mare
  
License MPLv2
Crystal 1.0.0

Authors

Dependencies 3

  • clim 0.13.0
    {'github' => 'at-grandpa/clim', 'version' => '0.13.0'}
  • lsp
    {'github' => 'jemc/crystal-lsp'}
  • pegmatite
    {'github' => 'jemc/crystal-pegmatite'}

Development Dependencies 0

Dependents 0

Last synced .
search fire star recently