mirror of https://github.com/saymrwulf/xous-core.git synced 2026-11-04 04:27:34 +00:00

History

bunnie 89f92c28a2 Merge branch 'main' into nto-work		2024-08-19 02:30:35 +08:00
..
bin	add the .a artifacts to the tree for the asm.S	2024-01-06 16:41:40 +08:00
src	Merge branch 'main' into nto-work	2024-08-19 02:30:35 +08:00
assemble.ps1
assemble.sh
build.rs	ok, format the kernel now that all in-line assembly has been checked	2024-01-14 19:27:14 +08:00
Cargo.toml	patches to clean up warnings in rust-1.80	2024-08-19 02:24:24 +08:00
link.x
README.md

README.md

Xous Kernel

This contains the core kernel for Xous. It requires a stage 1 loader in order to start up, as it assumes the system is already running in Supervisor mode.

Building

To build the kernel, you will need a riscv32 target for Rust. Possible targets include riscv32i-unknown-none-elf, riscv32imac-unknown-none-elf, or riscv32imac-unknown-xous-elf.

Decide what target you want. For simple, embedded systems this could be riscv32i-unknown-none-elf, and for more complex systems with compressed instructions you could use riscv32imac-unknown-none-elf.
Get Rust. Go to https://rustup.rs/ and follow its instructions.
Install the proper toolchain: rustup target add ${target_arch}
Build the kernel: cargo build --release --target ${target_arch}

Using

To use the kernel, you must package it up into an arguments binary with xous-tools.

Testing

TBD

Contribution Guidelines

Please see CONTRIBUTING for details on how to make a contribution.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide its terms.

License

This project is licensed under the Apache License 2.0 LICENSE. For accurate information, please check individual files.