RuyiSDK Getting Started Example

This example can be compiled and run directly on the development board, making it suitable for beginners.

Install dependencies

sudo apt update; sudo apt install -y wget tar zstd xz-utils git build-essential

Install the ruyi package manager (see the official installation guide for other methods)

wget https://mirror.iscas.ac.cn/ruyisdk/ruyi/tags/0.51.0/ruyi-0.51.0.riscv64
chmod +x ./ruyi-0.51.0.riscv64
sudo cp -v ./ruyi-0.51.0.riscv64 /usr/local/bin/ruyi

Install the GCC and LLVM toolchains

ruyi update

ruyi install gnu-plct llvm-plct

Hello World (GCC)

Create and activate the ruyi virtual environment (GCC)

ruyi venv -t toolchain/gnu-plct manual venv-gnu-plct
. ~/venv-gnu-plct/bin/ruyi-activate

Verify the GCC version

riscv64-plct-linux-gnu-gcc -v

Compile and run Hello World (GCC)

cat > hello.c << 'EOF'
#include <stdio.h>

int main() {
    printf("Hello, World!\n");
    return 0;
}
EOF

riscv64-plct-linux-gnu-gcc hello.c -o hello-gcc
./hello-gcc

Under normal circumstances, the terminal displays output similar to:

work@work-sipeedlpi3aboard:~$ source venv-gnu-plct/bin/ruyi-activate
<@work-sipeedlpi3aboard:~$ riscv64-plct-linux-gnu-gcc hello.c -o hello-gcc
«Ruyi venv-gnu-plct» work@work-sipeedlpi3aboard:~/$ ./hello-gcc
Hello, World!
«Ruyi venv-gnu-plct» work@work-sipeedlpi3aboard:~$ █

Exit the ruyi GCC virtual environment

cd ..; ruyi-deactivate

Hello World (LLVM)

Create and activate the ruyi virtual environment (LLVM)

ruyi venv -t toolchain/llvm-plct manual --sysroot-from gnu-plct venv-llvm-plct
. ~/venv-llvm-plct/bin/ruyi-activate

Verify the LLVM version

clang -v

Compile and run Hello World (LLVM)

clang hello.c -o hello-llvm; ./hello-llvm

Under normal circumstances, the terminal displays output similar to:

«Ruyi venv-gnu-plct» work@work-sipeedlpi3aboard:~/coremark$ ruyi-deactivate
work@work-sipeedlpi3aboard:~/coremark$ cd ..
work@work-sipeedlpi3aboard:~$ source venv-llvm-plct/bin/ruyi-activate
<k@work-sipeedlpi3aboard:~$ clang hello.c -o hello-llvm
«Ruyi venv-llvm-plct» work@work-sipeedlpi3aboard:~$ ./hello-llvm
Hello, World!
«Ruyi venv-llvm-plct» work@work-sipeedlpi3aboard:~$

Exit the ruyi LLVM virtual environment

cd ..; ruyi-deactivate