From c00a4557376e02308f4dbf77c7ace4742aed1ad9 Mon Sep 17 00:00:00 2001 From: StunxFS Date: Fri, 29 Nov 2024 12:53:26 -0400 Subject: [PATCH] readme: update --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 1f480af68..d73d00352 100644 --- a/README.md +++ b/README.md @@ -21,10 +21,22 @@ A general-purpose programming language, focused on simplicity, safety and stabil Rivet's goal is to be a very powerful programming language and at the same time easy to use, whose syntax is inspired by Go, Zig and C# and other programming languages. -Currently, Rivet uses C as the only backend and generates C99 code that is compiled using -a C compiler (by default, GCC or Clang). The idea is that in the long term there will be -other backends available for code generation, such as LLVM or WebAssembly, and also that -there will be an interpreter available. +> [!IMPORTANT] +> Currently the language is in alpha state, and therefore its syntax and the language +> API is not stable, and may change in the long term. Not all features are implemented. +> +> Compiler version 0.1.0 will be released when the self-hosted compiler can compile itself +> successfully. +> +> Only linux is supported for now. Windows is not well supported, and macOS is not supported +> yet. Any help to provide full support for both Windows and macOS is welcome. +> +> Read [CONTRIBUTING](CONTRIBUTING.md) to get more information. + +Rivet uses C as the only backend and generates C99 code that is compiled using a C compiler +(by default, GCC or Clang). The idea is that in the long term there will be other backends +available for code generation, such as LLVM or WebAssembly, and also that there will be an +interpreter available. You can find information on how to build Rivet on your computer by going to the [documentation](https://rivet-lang.github.io/docs). @@ -36,15 +48,3 @@ fn main() { console.writeln("Hello World!"); } ``` - -> [!IMPORTANT] -> Currently the language is in alpha state, and therefore its syntax and the language -> API is not stable, and may change in the long term. Not all features are implemented. -> -> Compiler version 0.1.0 will be released when the self-hosted compiler can compile itself -> successfully. -> -> Only linux is supported for now. Windows is not well supported, and macOS is not supported -> yet. Any help to provide full support for both Windows and macOS is welcome. -> -> Read [CONTRIBUTING](CONTRIBUTING.md) to get more information. \ No newline at end of file