Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Robert-M-Lucas authored Oct 19, 2024
1 parent 794c409 commit 4d24076
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
# Whython-8

The `master` branch should now contain a semi-stable version whereas
the latest version can be found on `dev`. I also use `dev` to sync
my work so expect constant breaking changes on that branch.
Whython-8 is a compiled programming language with no runtime. It compiles to raw NASM
assembly without an intermediate step like LLVM. As this is a work-in-progress there
is no documentation on how to write Whython code however you should be able to get a
general idea by looking at any `.why` files e.g. in the root, in `std`, and in `reference`.
Some of these may be broken due to breaking changes

This is designed to work on Linux using `nasm` and `gcc` requiring a library
with `free`, `malloc`, and `printf` to be present (should be by default,
all may not be required if not used in your code). This may work in WSL

The `master` branch should now contain a semi-stable version whereas
the latest version can be found on `dev`. I also use `dev` to sync
my work so expect constant breaking changes on that branch.

## Usage

`cargo run` will compile and run `main.why`. By default this runs an example
Expand All @@ -18,4 +24,4 @@ two examples of the rich error reporting in Whython

Use `cargo run -- [args]` to pass arguments to Whython

Use `cargo run -- -h` to get help
Use `cargo run -- -h` to get help

0 comments on commit 4d24076

Please sign in to comment.