Updated readme

This commit is contained in:
2025-11-21 15:13:41 +01:00
parent 663ff612ba
commit 219033be0d

View File

@@ -7,7 +7,7 @@ An experimental lazy, pure functional programming language designed to be embedd
## Usage
The standalone interpreter can be built as the binary target from this package. The language tutorial and standard library documentation is at [www.lbfalvy.com/orchid-reference](https://lbfalvy.github.io/orchid-reference/). Embedder guide and Rust API documentation are coming soon.
Updated language tutorial, standard library documentation, embedder guide and Rust API documentation coming soon.
## Design
@@ -19,10 +19,10 @@ Namespaces are inspired by Rust modules and ES6. Every file and directory is imp
## Try it out
The project uses the nighly rust toolchain. Go to one of the folders within `examples` and run
The project uses both the stable and nightly rust toolchain. Run the examples with
```sh
cargo run --release
cargo orcx -- exec --proj ./examples/hello-world "src::main::main"
```
you can try modifying the examples, but error reporting for the time being is pretty terrible.
@@ -35,7 +35,7 @@ Orchids and mangrove trees form complex ecosystems; The flowers persuade the tre
All contributions are welcome. For the time being, use the issue tracker to discuss ideas.
By contributing to this software, you declare that you have created or otherwise own your contribution, agree to license it under the general noncommercial licence included in this repository, and grant me (the owner of the project) a permanent, unrestricted license to use, modify, distribute and relicense your contribution under any terms I see fit.
Unless we agree on different terms, by contributing to this software you declare that you have created or otherwise have the right to license your contribution, agree to license it publicly under the general noncommercial licence included in this repository, and grant me (the owner of the project) a permanent, unrestricted license to use, modify, distribute and relicense your contribution under any terms I see fit.
## About the license