Hello, World!

The quickest "hello world" is to run Xous under emulation on your PC using hosted mode.

  1. Get the latest rust or run rustup update if you already have Rust installed.
  2. Clone xous-core.
  3. Inside the xous-core directory, run cargo xtask run.

Notes:

  • If you have updated rust or have tinkered with std on your system, you can re-install the xous target with cargo xtask install-toolkit --force, and then run rm -r target to force remove stale build files.
  • You may also need to install some additional libraries, such as libxkbdcommon-dev.
  • :warning: hosted mode is literally Xous running on your local host, which means it supports more features than Xous on native hardware:
    • We do not have tokio support planned anytime soon.
    • We do not have File support in Xous; instead, we have the pddb.
    • Net support in actively in development and we hope to have fairly robust support for libstd Net but, note that socket2 crate (which is not part of Rust libstd) does not recognize Xous as a supported host.

Running on Hardware

Baochip Users

See Getting Started with Baochip Targets.

Note that there is a vscode extension for the Baochip family of targets. Look for baochip in the extension store.

Precursor Users

  • Please refer to the manifest.json documentation for integration notes
  • repl app demo is the starting point for users who want to interact with their device by typing commands. This demo leverages more of the Xous UX built-in frameworks.
  • ball app demo is the starting point for users who prefer to run close to the bare iron, getting only key events and a framebuffer for crafting games and bespoke apps.