Skip to content

Commit 5d2e394

Browse files
authored
chore: fixed broken links (#375)
* fixed broken links in riscv `instruction.rs` * updated formating of link `runtime/README.md` * Update link `runtime/README.md`
1 parent fa96277 commit 5d2e394

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

runtime/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ function directly. The fourth line brings the nexux-rt
6868
`main` function as the starting point of the program.
6969

7070
To see more, such as how to introduce program i/o, precompiles,
71-
and native compilation support, check out our [documentation](docs.nexus.xyz).
71+
and native compilation support, check out our [documentation](https://docs.nexus.xyz/zkvm/index).
7272

7373
## Crate Overview
7474
#### Execution flow
@@ -87,4 +87,4 @@ and native compilation support, check out our [documentation](docs.nexus.xyz).
8787
- `#[nexus_rt::main]` transforms the main body of a rust function to make the development process simpler and more intuitive. In this way, at surface level the main function will take inputs and return outputs as defined in the function signature (Ex: `fn main(x: u32) -> u32`). Under the hood, the guest program I/O memory interactions will happen via `read_public_input`, `read_private_input`, and `write_public_output` in `src/io.rs`.
8888
- By default all I/O will be treated as public I/O. To create a private input `x`, define the variable in the main function signature, and use the macro `[nexus_rt::private_input(x)]`.
8989
- The guest program development workflow allows for simultaneous multi-target compatibility. In order for this to work, every input and output variable must have a corresponding native handler (since native running has no concept of guest program memory). The macros for this are `[nexus_rt::custom_input]` and `[nexus_rt::custom_output]`.
90-
- All of these definitions can be found in `macros/`. For additional examples and understanding, refer to `macros/macro_expansion_tests/tests`. Note that macros expand differently depending on the target (native vs RISC-V).
90+
- All of these definitions can be found in `macros/`. For additional examples and understanding, refer to `macros/macro_expansion_tests/tests`. Note that macros expand differently depending on the target (native vs RISC-V).

vm/src/riscv/instructions/instruction.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
//! various RISC-V instruction formats.
66
//!
77
//! References:
8-
//! - <https://github.com/riscv/riscv-opcodes/blob/master/rv32_i>
9-
//! - <https://github.com/riscv/riscv-opcodes/blob/master/rv_i>
10-
//! - <https://github.com/riscv/riscv-opcodes/blob/master/rv_m>
8+
//! - <https://github.com/riscv/riscv-opcodes/blob/master/extensions/rv32_i>
9+
//! - <https://github.com/riscv/riscv-opcodes/blob/master/extensions/rv_i>
10+
//! - <https://github.com/riscv/riscv-opcodes/blob/master/extensions/rv_m>
1111
1212
use crate::riscv::instructions::macros::{
1313
impl_b_type_instructions, impl_i_type_instructions, impl_i_type_shamt_instructions,

0 commit comments

Comments
 (0)