Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: include README as module doc #854

Merged
merged 1 commit into from
Nov 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Please note that the Lurk language and spec will be versioned independently from
Lurk source files used in tests are in the [lurk-lib](https://github.com/lurk-lab/lurk-lib) submodule. You must
initialize and update submodules before test will pass:

```
```ignore
git submodule update --init --recursive
```

Expand All @@ -69,32 +69,32 @@ git submodule update --init --recursive
- [clang](https://clang.llvm.org/get_started.html)

Lurk can be compiled to Wasm with
```
```ignore
cargo build --target wasm32-unknown-unknown
```

If using Nix without a system-wide `clang` install (e.g. NixOS):
```
```ignore
CC=clang cargo build --target wasm32-unknown-unknown
```

## Repl

```
```ignore
cargo run --release
```

Or use the wrapper script:

```
```ignore
bin/lurk
```

Set the environment variable `LURK_FIELD` to specify the scalar field of the Lurk language instance:
- `LURK_FIELD=PALLAS` (default): scalar field of Pallas
- `LURK_FIELD=VESTA`: scalar field of Vesta

```
```ignore
➜ lurk-rs ✗ bin/lurk
Finished release [optimized] target(s) in 0.06s
Running `target/release/lurk`
Expand All @@ -105,7 +105,7 @@ Lurk REPL welcomes you.
```

Or enable `info` log-level for a trace of reduction frames:
```
```ignore
➜ lurk-rs ✗ RUST_LOG=info bin/lurk
Finished release [optimized] target(s) in 0.05s
Running `target/release/lurk`
Expand Down Expand Up @@ -158,26 +158,26 @@ Lurk REPL welcomes you.
## Install

You can install the `lurk` Repl on your machine with
```
```ignore
$ cargo install --path .
```

## Nix

Install [Nix](https://nixos.org) and [enable Nix flakes](https://nixos.wiki/wiki/Flakes). Then, you can enter into a Nix devshell with the appropriate dependencies for Lurk with

```
```ignore
$ nix develop
```
or

```
```ignore
$ direnv allow
```

And then build with Cargo as usual:

```
```ignore
$ cargo build
```

Expand Down
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#![doc = include_str!("../README.md")]
#![deny(unreachable_pub)]

#[macro_use]
Expand Down
Loading