updated readme
This commit is contained in:
@@ -19,6 +19,25 @@ Clyx aims for maximum portability and can be implemented in any modern runtime e
|
|||||||
- Platform-agnostic [standard library](lib.clx)
|
- Platform-agnostic [standard library](lib.clx)
|
||||||
- Ability to include custom modules into the current runtime context (depends on file I/O capabilities)
|
- Ability to include custom modules into the current runtime context (depends on file I/O capabilities)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Depending on the implementation, there are several installation ways.
|
||||||
|
|
||||||
|
### Reference Python implementation installation
|
||||||
|
```sh
|
||||||
|
pip install "git+https://codeberg.org/luxferre/clyx.git#subdirectory=clyx-python"
|
||||||
|
```
|
||||||
|
|
||||||
|
This will install the REPL as `clyx` into your current environment.
|
||||||
|
|
||||||
|
### Reference implementation for CircuitPython + [T-DeckARD](https://codeberg.org/luxferre/t-deckard) runtime
|
||||||
|
|
||||||
|
Clone this repo, then mount your T-Deck's CircuitPython volume, and then run:
|
||||||
|
```sh
|
||||||
|
sh dist-python.sh /path/to/mounted/volume/app/clyx
|
||||||
|
```
|
||||||
|
This will install Clyx as a T-DeckARD applet.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Note: this section describes how to run the interpreter itself. For the language manual, refer to [Clyx Reference Manual](clyx_manual.md).
|
Note: this section describes how to run the interpreter itself. For the language manual, refer to [Clyx Reference Manual](clyx_manual.md).
|
||||||
@@ -27,10 +46,16 @@ All core implementations must accept a `.clx` file to run (either via command li
|
|||||||
|
|
||||||
To run the REPL with the reference Python implementation, run `[micro]python clyx.py clyx_repl.clx` command.
|
To run the REPL with the reference Python implementation, run `[micro]python clyx.py clyx_repl.clx` command.
|
||||||
|
|
||||||
|
To run the REPL inside T-DeckARD:
|
||||||
|
```
|
||||||
|
from app.clyx import clyx
|
||||||
|
clyx.repl()
|
||||||
|
```
|
||||||
|
Don't forget to mount an SD card or run `unlock_rootfs()` if you want to use file writing capabilities inside T-DeckARD environment.
|
||||||
|
|
||||||
## Implementations
|
## Implementations
|
||||||
|
|
||||||
- [Reference implementation in Python](./clyx.py) (compatible with MicroPython and CircuitPython)
|
- [Reference implementation in Python](clyx-python/clyx/clyx.py) (compatible with MicroPython and CircuitPython)
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
### Where does the name Clyx originate from?
|
### Where does the name Clyx originate from?
|
||||||
|
|||||||
Reference in New Issue
Block a user