Nuclei Open Source Virtual Platform

# NOTE: for internal developer, please use internal git repo url
git clone https://github.com/riscv-mcu/nuclei_vp
cd nuclei_vp
# checkout wip branch or other branch you need
# this is still under development, so branch is named wip
git checkout wip
# make sure this step below executed successfully
git submodule update --init --recursive
# check repo status and git submodule status
git status
git submodule

# in host now
# The docker is a prebuilt one, uploaded to docker hub, see https://hub.docker.com/r/nucleisoftware/ubuntu/tags
bash scripts/run_docker.sh
# now in docker

# in docker now
cd /work
# build nuclei vp project in vp.build folder
# it will automatically build and install this project
# if you want to build it in a new folder, change vp.build to another name
bash scripts/build.sh vp.build

# in docker now
## build freeloader and qemu disk images using nuclei linux sdk or use a prebuilt image
## see https://github.com/Nuclei-Software/nuclei-linux-sdk/tree/dev_nuclei_6.1_v2#booting-linux-on-nuclei-qemu
## simple steps in nuclei-linux-sdk repo is as below
## $ make SOC=evalsoc CORE=ux900fd freeloader gendisk
## then you can copy <nuclei-linux-sdk>/work/evalsoc/freeloader.elf and <nuclei-linux-sdk>/work/evalsoc/disk.img to <nuclei_vp>/images/
## or you can download a prebuilt version from https://drive.weixin.qq.com/s?k=ABcAKgdSAFcZkIVSxF
## extract it to <nuclei_vp>/images folder
# run this virtual platform located in vp.build
bash scripts/run.sh vp.build

# in docker now
## build baremetal case for nx900fd using nuclei sdk
## see https://doc.nucleisys.com/nuclei_sdk/design/app.html
## using SOC=evalsoc CORE=nx900fd
## extract it to <nuclei_vp>/images folder
# run this virtual platform located in vp.build
# default elf is images/baremetal.elf
bash scripts/run.sh vp.build conf/riscv64_bare.lua