Skip to content

Commit 30c85cf

Browse files
authored
Merge pull request #10 from aurae-runtime/More-release-docs
Minor docs updates
2 parents af23f8d + 027cfff commit 30c85cf

1 file changed

Lines changed: 12 additions & 9 deletions

File tree

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This repository will maintain the releases for the aurae project.
44

5-
### Project Status
5+
## Project Status
66

77
The project is very young and under active development. The APIs are subject to change without notice until further notice.
88
As we continue to develop the project the APIs will stabilize and eventually a long term stable release will be offered.
@@ -11,20 +11,23 @@ At this time the project should not be run in production.
1111

1212
Please read [getting involved](https://aurae.io/community/#getting-involved) if you are interested in joining the project in its early phases. Contribution types of all types and ranges are welcome.
1313

14-
### Release Artifacts
14+
## Release Artifacts
1515

1616
> Note: some of these links may not function until we release the first build
1717
1818
The following artifacts will be available with every stable build. While we are in alpha, only artifacts that share the same version are known to be compatible.
1919

20-
| Build | Repository | Architectures | Artifacts | Status |
21-
| ------------------------------------------------------------------------------- | ---------- | ---------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
22-
| [auraed](https://github.com/aurae-runtime/aurae/tree/main/auraed) | | `x86_64-unknown-linux` | [Releases](https://github.com/aurae-runtime/aurae/releases) | ![Main Build](https://github.com/aurae-runtime/aurae/actions/workflows/001-cargo-install-ubuntu-make-build.yml/badge.svg?branch=main) |
23-
| [auraescript](https://github.com/aurae-runtime/aurae/tree/main/auraescript) | | `x86_64-unknown-linux` | [Releases](https://github.com/aurae-runtime/aurae/releases) | ![Main Build](https://github.com/aurae-runtime/aurae/actions/workflows/001-cargo-install-ubuntu-make-build.yml/badge.svg?branch=main) |
24-
| [aer](https://github.com/aurae-runtime/aurae-runtime/aer/tree/main/auraescript) | | `x86_64-unknown-linux` | [Releases](https://github.com/aurae-runtime/aurae/releases) | ![Main Build](https://github.com/aurae-runtime/aurae/actions/workflows/001-cargo-install-ubuntu-make-build.yml/badge.svg?branch=main) |
25-
| [ae](https://github.com/aurae-runtime/ae) | | `x86_64` | [Releases](https://github.com/aurae-runtime/ae/releases) | |
20+
| Build | Architectures| Artifacts| Status|
21+
|------------------------------------------------------------------------------- | ---------------------- | -----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------- |
22+
| [auraed](https://github.com/aurae-runtime/aurae/tree/main/auraed) | `x86_64-unknown-linux` | [Releases](https://github.com/aurae-runtime/aurae/releases) | ![Main Build](https://github.com/aurae-runtime/aurae/actions/workflows/001-cargo-install-ubuntu-make-build.yml/badge.svg?branch=main) |
23+
| [auraescript](https://github.com/aurae-runtime/aurae/tree/main/auraescript) | `x86_64-unknown-linux` | [Releases](https://github.com/aurae-runtime/aurae/releases) | ![Main Build](https://github.com/aurae-runtime/aurae/actions/workflows/001-cargo-install-ubuntu-make-build.yml/badge.svg?branch=main) |
24+
| [aer](https://github.com/aurae-runtime/aurae-runtime/aer/tree/main/auraescript) | `x86_64-unknown-linux` | [Releases](https://github.com/aurae-runtime/aurae/releases) | ![Main Build](https://github.com/aurae-runtime/aurae/actions/workflows/001-cargo-install-ubuntu-make-build.yml/badge.svg?branch=main) |
25+
| [ae](https://github.com/aurae-runtime/ae) | `x86_64` | [Releases](https://github.com/aurae-runtime/ae/releases) | |
2626

27-
### Support
27+
## Release Process
28+
The instructions to cut a release are available in the [RELEASE.md](/RELEASE.md).
29+
30+
## Support
2831

2932
Please check out our [FAQ](#FAQ) section to see if it might help address your issue. Our [website](https://aurae.io/community/) also has information that may help.
3033

0 commit comments

Comments
 (0)