forked from Orchid/orchid
Touchups
- Added logo and social preview - added icon to docs
This commit is contained in:
17
README.md
17
README.md
@@ -1,12 +1,17 @@
|
||||
Orchid is an experimental lazy, pure functional programming language designed to be embeddable in a Rust application for scripting.
|
||||
<h1 align="center">
|
||||
<img src="icon.svg" alt="logo" height="60px">
|
||||
Orchid
|
||||
</h1>
|
||||
|
||||
# Usage
|
||||
An experimental lazy, pure functional programming language designed to be embeddable in a Rust application for scripting.
|
||||
|
||||
## Usage
|
||||
|
||||
TODO
|
||||
|
||||
I need to write a few articles explaining individual fragments of the language, and accurately document everything. Writing tutorials at this stage is not really worth it.
|
||||
|
||||
# Design
|
||||
## Design
|
||||
|
||||
The execution model is lambda calculus, with call by name and copy tracking to avoid repeating steps. This leads to the minimal number of necessary reduction steps.
|
||||
|
||||
@@ -14,7 +19,7 @@ To make the syntax more intuitive, completely hygienic macros can be used which
|
||||
|
||||
Namespaces are inspired by Rust modules and ES6. Every file and directory is implicitly a public module. Files can `export` names of constants or namespaces, all names in a substitution rule, or explicitly export some names. Names are implicitly created when they're referenced. `import` syntax is similar to Rust except with `(` parentheses `)` and no semicolons.
|
||||
|
||||
# Try it out
|
||||
## Try it out
|
||||
|
||||
The project uses the nighly rust toolchain. Go to one of the folders within `examples` and run
|
||||
|
||||
@@ -24,10 +29,10 @@ cargo run --release
|
||||
|
||||
you can try modifying the examples, but error reporting for the time being is pretty terrible.
|
||||
|
||||
# The name
|
||||
## The name
|
||||
|
||||
Orchids and mangrove trees form complex ecosystems; The flowers persuade the tree to grow in different ways than it normally would to provide better support for their vines, and kill fungi and other pests. The metaphor is about vines growing on a tree and moving branches into more optimal positions for other vines.
|
||||
|
||||
# Contribution
|
||||
## Contribution
|
||||
|
||||
All contributions are welcome. For the time being, use the issue tracker to discuss ideas.
|
||||
Reference in New Issue
Block a user