24 changed files with 104 additions and 104 deletions
@ -1,23 +1,23 @@
|
||||
# Contributing |
||||
|
||||
The easiest way to contribute to the Sabre project is by writing code in the language. The more the language is battle-tested, the more bugs can be found and therefore the language becomes more stable. |
||||
The easiest way to contribute to the Antimony project is by writing code in the language. The more the language is battle-tested, the more bugs can be found and therefore the language becomes more stable. |
||||
|
||||
## Getting in touch |
||||
|
||||
If you have a question, found a potential bug or want to engage with the community, you can join the [matrix room](https://matrix.to/#/#sabre:matrix.slashdev.space?via=matrix.slashdev.space) of this project. If you prefer to stay away from matrix, you can also send a mail (or a patch) to the [public mailing list](https://lists.sr.ht/~garritfra/sabre). |
||||
If you have a question, found a potential bug or want to engage with the community, you can join the [matrix room](https://matrix.to/#/#antimony:matrix.slashdev.space?via=matrix.slashdev.space) of this project. If you prefer to stay away from matrix, you can also send a mail (or a patch) to the [public mailing list](https://lists.sr.ht/~garritfra/antimony). |
||||
|
||||
## Fixing things and adding features |
||||
|
||||
If you want to contribute to the compiler itself, the easiest way to get started is to look at the [open issues](https://github.com/garritfra/sabre/issues) of the project. Usually, this is where important todo items are jotted down and bugs are reported. |
||||
If you want to contribute to the compiler itself, the easiest way to get started is to look at the [open issues](https://github.com/garritfra/antimony/issues) of the project. Usually, this is where important todo items are jotted down and bugs are reported. |
||||
|
||||
You could also run the tests (`cargo test`) and see if any tests are ignored. Usually, if a bug is found in the wild, a failing but ignored test is written, so that it can be further investigated later. |
||||
|
||||
## Writing documentation |
||||
|
||||
As with all software, Sabre needs good documentation. Since Sabre is still in early development, things change constantly. This means that docs will be out of date in a lot of cases, or not written at all. Any help with the documentation is greatly appreciated! |
||||
As with all software, Antimony needs good documentation. Since Antimony is still in early development, things change constantly. This means that docs will be out of date in a lot of cases, or not written at all. Any help with the documentation is greatly appreciated! |
||||
|
||||
## Submitting your code |
||||
|
||||
If you want to contribute code, please open a pull request on [GitHub](https://github.com/garritfra/sabre). There is also a [SourceHut mirror](https://sr.ht/~garritfra/sabre/), if you're trying to avoid GitHub. Feel free to send a patch to the [public mailing list](https://lists.sr.ht/~garritfra/sabre). Check out [this guide](https://slashdev.space/posts/patch-based-git-workflow) to learn about the patch based workflow. |
||||
If you want to contribute code, please open a pull request on [GitHub](https://github.com/garritfra/antimony). There is also a [SourceHut mirror](https://sr.ht/~garritfra/antimony/), if you're trying to avoid GitHub. Feel free to send a patch to the [public mailing list](https://lists.sr.ht/~garritfra/antimony). Check out [this guide](https://slashdev.space/posts/patch-based-git-workflow) to learn about the patch based workflow. |
||||
|
||||
Before submitting the code, please make sure that it is **sufficiently documented and tested**. |
||||
|
||||
@ -1,5 +1,5 @@
|
||||
# Common language concepts |
||||
|
||||
This chapter covers concepts that appear in almost every programming language and how they work in Sabre. Many programming languages have much in common at their core. |
||||
This chapter covers concepts that appear in almost every programming language and how they work in Antimony. Many programming languages have much in common at their core. |
||||
|
||||
Specifically, you’ll learn about variables, basic types, functions, comments, and control flow. These foundations will be in every Sabre program, and learning them early will give you a strong core to start from. |
||||
Specifically, you’ll learn about variables, basic types, functions, comments, and control flow. These foundations will be in every Antimony program, and learning them early will give you a strong core to start from. |
||||
|
||||
@ -1 +1 @@
|
||||
This chapter includes resources that might be helpful for developers hacking on the Sabre compiler. |
||||
This chapter includes resources that might be helpful for developers hacking on the Antimony compiler. |
||||
|
||||
@ -1,23 +1,23 @@
|
||||
# Contributing |
||||
|
||||
The easiest way to contribute to the Sabre project is by writing code in the language. The more the language is battle-tested, the more bugs can be found and therefore the language becomes more stable. |
||||
The easiest way to contribute to the Antimony project is by writing code in the language. The more the language is battle-tested, the more bugs can be found and therefore the language becomes more stable. |
||||
|
||||
## Getting in touch |
||||
|
||||
If you have a question, found a potential bug or want to engage with the community, you can join the [matrix room](https://matrix.to/#/#sabre:matrix.slashdev.space?via=matrix.slashdev.space) of this project. If you prefer to stay away from matrix, you can also send a mail (or a patch) to the [public mailing list](https://lists.sr.ht/~garritfra/sabre). |
||||
If you have a question, found a potential bug or want to engage with the community, you can join the [matrix room](https://matrix.to/#/#antimony:matrix.slashdev.space?via=matrix.slashdev.space) of this project. If you prefer to stay away from matrix, you can also send a mail (or a patch) to the [public mailing list](https://lists.sr.ht/~garritfra/antimony). |
||||
|
||||
## Fixing things and adding features |
||||
|
||||
If you want to contribute to the compiler itself, the easiest way to get started is to look at the [open issues](https://github.com/garritfra/sabre/issues) of the project. Usually, this is where important todo items are jotted down and bugs are reported. |
||||
If you want to contribute to the compiler itself, the easiest way to get started is to look at the [open issues](https://github.com/garritfra/antimony/issues) of the project. Usually, this is where important todo items are jotted down and bugs are reported. |
||||
|
||||
You could also run the tests (`cargo test`) and see if any tests are ignored. Usually, if a bug is found in the wild, a failing but ignored test is written, so that it can be further investigated later. |
||||
|
||||
## Writing documentation |
||||
|
||||
As with all software, Sabre needs good documentation. Since Sabre is still in early development, things change constantly. This means that docs will be out of date in a lot of cases, or not written at all. Any help with the documentation is greatly appreciated! |
||||
As with all software, Antimony needs good documentation. Since Antimony is still in early development, things change constantly. This means that docs will be out of date in a lot of cases, or not written at all. Any help with the documentation is greatly appreciated! |
||||
|
||||
## Submitting your code |
||||
|
||||
If you want to contribute code, please open a pull request on [GitHub](https://github.com/garritfra/sabre). There is also a [SourceHut mirror](https://sr.ht/~garritfra/sabre/), if you're trying to avoid GitHub. Feel free to send a patch to the [public mailing list](https://lists.sr.ht/~garritfra/sabre). Check out [this guide](https://slashdev.space/posts/patch-based-git-workflow) to learn about the patch based workflow. |
||||
If you want to contribute code, please open a pull request on [GitHub](https://github.com/garritfra/antimony). There is also a [SourceHut mirror](https://sr.ht/~garritfra/antimony/), if you're trying to avoid GitHub. Feel free to send a patch to the [public mailing list](https://lists.sr.ht/~garritfra/antimony). Check out [this guide](https://slashdev.space/posts/patch-based-git-workflow) to learn about the patch based workflow. |
||||
|
||||
Before submitting the code, please make sure that it is **sufficiently documented and tested**. |
||||
|
||||
@ -1,5 +1,5 @@
|
||||
# AST |
||||
|
||||
This module contains the node types of the Sabre AST. |
||||
This module contains the node types of the Antimony AST. |
||||
|
||||
The most important node is `Module`, which is the abstract representation of a Sabre file. |
||||
The most important node is `Module`, which is the abstract representation of a Antimony file. |
||||
|
||||
@ -1,5 +1,5 @@
|
||||
# Builder |
||||
|
||||
The builder module provides a simple interface to compile a Sabre program. |
||||
The builder module provides a simple interface to compile a Antimony program. |
||||
|
||||
The `Builder` structure takes in a path to a Sabre program. Calling `.build()` will construct the internal representation of the program, and `.generate()` outputs the program to a target file. |
||||
The `Builder` structure takes in a path to a Antimony program. Calling `.build()` will construct the internal representation of the program, and `.generate()` outputs the program to a target file. |
||||
|
||||
Loading…
Reference in new issue