Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
refaktor authored Aug 4, 2024
1 parent ae16a3c commit 36b71f2
Showing 1 changed file with 27 additions and 9 deletions.
36 changes: 27 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,40 +239,52 @@ Clone the main branch from the Rye repository:

git clone https://github.com/refaktor/rye.git && cd rye

Build the tiny version of Rye:
Build the tiny version of Rye (with minimal modules):

go build -tags "b_tiny"
go build -tags "b_tiny" -o bin/rye

Build the normal version of Rye (with most "batteries" packed in):

go build -o bin/rye

# or just run
./build

Run the rye file:

./rye hello.rye
bin/rye hello.rye

Run the Rye Console

./rye
bin/rye

Install build-essential if you don't already have it, for packages that require cgo (like sqlite):

sudo apt install build-essential

#### Build Rye with specific modules
<!-- #### Build Rye with specific modules
Rye has many bindings, that you can determine at build time, so (currently) you get a specific Rye binary for your specific project. This is an example of a build with many bindings.
I've been working on a way to make this more elegant and systematic, but the manual version is:
go build -tags "b_tiny,b_sqlite,b_http,b_sql,b_postgres,b_openai,b_bson,b_crypto,b_smtpd,b_mail,b_postmark,b_bcrypt,b_telegram"

-->

#### Build WASM version

Rye can also work inside your browser or any other WASM container. I will add examples, html pages and info about it, but to build it:

GOOS=js GOARCH=wasm go build -tags "b_tiny" -o wasm/rye.wasm main_wasm.go

Run the demo server for testing WASM version

# or just use
./buildwasm
# which will also start a webserver, visit http://localhost:8085/ryeshell/ then

<!-- Run the demo server for testing WASM version
bin/rye serve_wasm.rye
Then visit http://localhost:8085 or http://localhost:8085/ryeshell/
Then visit http://localhost:8085 or http://localhost:8085/ryeshell/ -->

#### Tests and function reference

Expand All @@ -290,6 +302,12 @@ Build the function reference out of tests:

Rye has Syntax highlighting for Emacs and VS Code. For VS Code just search for **ryelang** in the Extension marketplace. For Emacs it will be published soon on github.

## Rye related projects

[Rye-fyne](https://github.com/refaktor/rye-fyne) - external binding for Fyne GUI toolkit (wip)
[Pipefish](https://github.com/refaktor/rye-ebitengine) - external binding for Ebitengine game engine (wip)
[ryegen](https://github.com/refaktor/ryegen) - Rye binging generation toolkit (wip)

## Related links

[**Rebol**](http://www.rebol.com) - Rebol's author Carl Sassenrath invented or combined together 90% of concepts that Rye builds upon.
Expand Down

0 comments on commit 36b71f2

Please sign in to comment.